├── .nvmrc
├── .prettierrc
├── .eslintignore
├── .prettierignore
├── manager.js
├── preview.js
├── src
    ├── index.ts
    ├── constants.ts
    ├── preview.ts
    ├── types.ts
    ├── manager.ts
    ├── stories
    │   ├── Header.stories.ts
    │   ├── header.css
    │   ├── button.css
    │   ├── Page.stories.ts
    │   ├── Button.tsx
    │   ├── Button.stories.ts
    │   ├── assets
    │   │   ├── direction.svg
    │   │   ├── flow.svg
    │   │   ├── code-brackets.svg
    │   │   ├── comments.svg
    │   │   ├── repo.svg
    │   │   ├── plugin.svg
    │   │   ├── stackalt.svg
    │   │   └── colors.svg
    │   ├── page.css
    │   ├── Header.tsx
    │   ├── Page.tsx
    │   └── Introduction.mdx
    ├── components
    │   └── PanelContent.tsx
    ├── Panel.tsx
    └── withHTML.ts
├── .storybook
    ├── preview-head.html
    ├── local-preset.js
    ├── main.ts
    └── preview.ts
├── image.gif
├── screenshot.png
├── .gitignore
├── vite.config.ts
├── .eslintrc.yml
├── tsconfig.json
├── LICENSE
├── scripts
    ├── eject-typescript.js
    └── prepublish-checks.js
├── CONTRIBUTING.md
├── README.md
├── package.json
├── tsup.config.ts
└── CHANGELOG.md


/.nvmrc:
--------------------------------------------------------------------------------
1 | 18


--------------------------------------------------------------------------------
/.prettierrc:
--------------------------------------------------------------------------------
1 | {}
2 | 


--------------------------------------------------------------------------------
/.eslintignore:
--------------------------------------------------------------------------------
1 | dist
2 | 


--------------------------------------------------------------------------------
/.prettierignore:
--------------------------------------------------------------------------------
1 | dist
2 | CHANGELOG.md


--------------------------------------------------------------------------------
/manager.js:
--------------------------------------------------------------------------------
1 | import "./dist/manager";
2 | 


--------------------------------------------------------------------------------
/preview.js:
--------------------------------------------------------------------------------
1 | export * from "./dist/preview";
2 | 


--------------------------------------------------------------------------------
/src/index.ts:
--------------------------------------------------------------------------------
1 | // make it work with --isolatedModules
2 | export default {};
3 | 


--------------------------------------------------------------------------------
/.storybook/preview-head.html:
--------------------------------------------------------------------------------
1 | <script>
2 |   window.global = window;
3 | </script>
4 | 


--------------------------------------------------------------------------------
/image.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/whitespace-se/storybook-addon-html/HEAD/image.gif


--------------------------------------------------------------------------------
/screenshot.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/whitespace-se/storybook-addon-html/HEAD/screenshot.png


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | dist/
2 | node_modules/
3 | storybook-static/
4 | build-storybook.log
5 | .DS_Store
6 | .env


--------------------------------------------------------------------------------
/vite.config.ts:
--------------------------------------------------------------------------------
1 | import { defineConfig } from "vite";
2 | import react from "@vitejs/plugin-react";
3 | 
4 | // https://vitejs.dev/config/
5 | export default defineConfig({
6 |   plugins: [react()],
7 | });
8 | 


--------------------------------------------------------------------------------
/src/constants.ts:
--------------------------------------------------------------------------------
1 | export const ADDON_ID = "storybook/html";
2 | export const PANEL_ID = `${ADDON_ID}/panel`;
3 | export const PARAM_KEY = `html`;
4 | 
5 | export const EVENTS = {
6 |   CODE_UPDATE: `${ADDON_ID}/codeUpdate`,
7 | };
8 | 


--------------------------------------------------------------------------------
/src/preview.ts:
--------------------------------------------------------------------------------
1 | import type { ProjectAnnotations, Renderer } from "storybook/internal/types";
2 | import { withHTML } from "./withHTML";
3 | 
4 | const preview: ProjectAnnotations<Renderer> = {
5 |   decorators: [withHTML],
6 | };
7 | 
8 | export default preview;
9 | 


--------------------------------------------------------------------------------
/src/types.ts:
--------------------------------------------------------------------------------
 1 | export type Parameters = {
 2 |   highlighter?: {
 3 |     showLineNumbers?: boolean;
 4 |     wrapLines?: boolean;
 5 |   };
 6 |   root?: string;
 7 |   removeEmptyComments?: boolean;
 8 |   removeComments?: boolean | RegExp;
 9 |   transform?: (code: string) => string;
10 | };
11 | 


--------------------------------------------------------------------------------
/.eslintrc.yml:
--------------------------------------------------------------------------------
 1 | root: true
 2 | plugins:
 3 |   - import
 4 |   - react
 5 | extends:
 6 |   - eslint:recommended
 7 |   - plugin:import/recommended
 8 |   - plugin:react/recommended
 9 | parserOptions:
10 |   ecmaVersion: 2021
11 |   ecmaFeatures:
12 |     jsx: true
13 |   sourceType: module
14 | settings:
15 |   react:
16 |     version: "17"
17 | env:
18 |   browser: true
19 |   es6: true
20 |   node: true
21 | 


--------------------------------------------------------------------------------
/.storybook/local-preset.js:
--------------------------------------------------------------------------------
 1 | /**
 2 |  * to load the built addon in this test Storybook
 3 |  */
 4 | function previewAnnotations(entry = []) {
 5 |   return [...entry, require.resolve("../dist/preview.js")];
 6 | }
 7 | 
 8 | function managerEntries(entry = []) {
 9 |   return [...entry, require.resolve("../dist/manager.js")];
10 | }
11 | 
12 | module.exports = {
13 |   managerEntries,
14 |   previewAnnotations,
15 | };
16 | 


--------------------------------------------------------------------------------
/.storybook/main.ts:
--------------------------------------------------------------------------------
 1 | import type { StorybookConfig } from "@storybook/react-vite";
 2 | const config: StorybookConfig = {
 3 |   stories: ["../src/**/*.mdx", "../src/**/*.stories.@(js|jsx|ts|tsx)"],
 4 |   addons: ["@storybook/addon-links", "@storybook/addon-docs", "./local-preset.js"],
 5 | 
 6 |   framework: {
 7 |     name: "@storybook/react-vite",
 8 |     options: {},
 9 |   }
10 | };
11 | export default config;
12 | 


--------------------------------------------------------------------------------
/.storybook/preview.ts:
--------------------------------------------------------------------------------
 1 | import type { Preview } from "@storybook/react-vite";
 2 | 
 3 | const preview: Preview = {
 4 |   parameters: {
 5 |     backgrounds: {
 6 |       default: "light",
 7 |     },
 8 |     actions: { argTypesRegex: "^on[A-Z].*" },
 9 |     controls: {
10 |       matchers: {
11 |         color: /(background|color)$/i,
12 |         date: /Date$/,
13 |       },
14 |     },
15 |   },
16 | };
17 | 
18 | export default preview;
19 | 


--------------------------------------------------------------------------------
/src/manager.ts:
--------------------------------------------------------------------------------
 1 | import { addons, types } from "storybook/internal/manager-api";
 2 | import { ADDON_ID, PANEL_ID, PARAM_KEY } from "./constants";
 3 | import { Panel } from "./Panel";
 4 | 
 5 | // Register the addon
 6 | addons.register(ADDON_ID, () => {
 7 |   // Register the panel
 8 |   addons.add(PANEL_ID, {
 9 |     type: types.PANEL,
10 |     title: "HTML",
11 |     match: ({ viewMode }) => viewMode === "story",
12 |     render: Panel,
13 |     paramKey: PARAM_KEY,
14 |   });
15 | });
16 | 


--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "compilerOptions": {
 3 |     "allowSyntheticDefaultImports": true,
 4 |     "baseUrl": ".",
 5 |     "esModuleInterop": true,
 6 |     "experimentalDecorators": true,
 7 |     "incremental": false,
 8 |     "isolatedModules": true,
 9 |     "jsx": "react",
10 |     "lib": ["es2020", "dom"],
11 |     "module": "commonjs",
12 |     "noImplicitAny": true,
13 |     "rootDir": "./src",
14 |     "skipLibCheck": true,
15 |     "target": "ES2020"
16 |   },
17 |   "include": ["src/**/*"]
18 | }
19 | 


--------------------------------------------------------------------------------
/src/stories/Header.stories.ts:
--------------------------------------------------------------------------------
 1 | import type { Meta, StoryObj } from "@storybook/react-vite";
 2 | import { Header } from "./Header";
 3 | 
 4 | const meta: Meta<typeof Header> = {
 5 |   title: "Example/Header",
 6 |   component: Header,
 7 |   parameters: {
 8 |     // More on Story layout: https://storybook.js.org/docs/react/configure/story-layout
 9 |     layout: "fullscreen",
10 |   },
11 | };
12 | 
13 | export default meta;
14 | type Story = StoryObj<typeof Header>;
15 | 
16 | export const LoggedIn: Story = {
17 |   args: {
18 |     user: {
19 |       name: "Jane Doe",
20 |     },
21 |   },
22 | };
23 | 
24 | export const LoggedOut: Story = {};
25 | 


--------------------------------------------------------------------------------
/src/components/PanelContent.tsx:
--------------------------------------------------------------------------------
 1 | import React from "react";
 2 | import { SyntaxHighlighter } from "storybook/internal/components"
 3 | 
 4 | interface PanelContentProps {
 5 |   code: string;
 6 |   showLineNumbers?: boolean;
 7 |   wrapLines?: boolean;
 8 | }
 9 | 
10 | export const PanelContent: React.FC<PanelContentProps> = ({
11 |   code,
12 |   showLineNumbers = false,
13 |   wrapLines = false,
14 | }) => (
15 |   <SyntaxHighlighter
16 |     language={"html"}
17 |     copyable={true}
18 |     padded={true}
19 |     showLineNumbers={showLineNumbers}
20 |     wrapLongLines={wrapLines}
21 |     format={"html"}
22 |   >
23 |     {code}
24 |   </SyntaxHighlighter>
25 | );
26 | 


--------------------------------------------------------------------------------
/src/stories/header.css:
--------------------------------------------------------------------------------
 1 | .wrapper {
 2 |   font-family: "Nunito Sans", "Helvetica Neue", Helvetica, Arial, sans-serif;
 3 |   border-bottom: 1px solid rgba(0, 0, 0, 0.1);
 4 |   padding: 15px 20px;
 5 |   display: flex;
 6 |   align-items: center;
 7 |   justify-content: space-between;
 8 | }
 9 | 
10 | svg {
11 |   display: inline-block;
12 |   vertical-align: top;
13 | }
14 | 
15 | h1 {
16 |   font-weight: 700;
17 |   font-size: 20px;
18 |   line-height: 1;
19 |   margin: 6px 0 6px 10px;
20 |   display: inline-block;
21 |   vertical-align: top;
22 | }
23 | 
24 | button + button {
25 |   margin-left: 10px;
26 | }
27 | 
28 | .welcome {
29 |   color: #333;
30 |   font-size: 14px;
31 |   margin-right: 10px;
32 | }
33 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | GNU Affero General Public License
 2 | 
 3 | Copyright (c) 2022 Whitespace.
 4 | 
 5 | This program is free software: you can redistribute it and/or modify
 6 | it under the terms of the GNU Affero General Public License as
 7 | published by the Free Software Foundation, either version 3 of the
 8 | License, or (at your option) any later version.
 9 | 
10 | This program is distributed in the hope that it will be useful,
11 | but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 | GNU Affero General Public License for more details.
14 | 
15 | You should have received a copy of the GNU Affero General Public License
16 | along with this program.  If not, see http://www.gnu.org/licenses/.
17 | 


--------------------------------------------------------------------------------
/src/stories/button.css:
--------------------------------------------------------------------------------
 1 | .storybook-button {
 2 |   font-family: "Nunito Sans", "Helvetica Neue", Helvetica, Arial, sans-serif;
 3 |   font-weight: 700;
 4 |   border: 0;
 5 |   border-radius: 3em;
 6 |   cursor: pointer;
 7 |   display: inline-block;
 8 |   line-height: 1;
 9 | }
10 | .storybook-button--primary {
11 |   color: white;
12 |   background-color: #1ea7fd;
13 | }
14 | .storybook-button--secondary {
15 |   color: #333;
16 |   background-color: transparent;
17 |   box-shadow: rgba(0, 0, 0, 0.15) 0px 0px 0px 1px inset;
18 | }
19 | .storybook-button--small {
20 |   font-size: 12px;
21 |   padding: 10px 16px;
22 | }
23 | .storybook-button--medium {
24 |   font-size: 14px;
25 |   padding: 11px 20px;
26 | }
27 | .storybook-button--large {
28 |   font-size: 16px;
29 |   padding: 12px 24px;
30 | }
31 | 


--------------------------------------------------------------------------------
/src/stories/Page.stories.ts:
--------------------------------------------------------------------------------
 1 | import type { Meta, StoryObj } from '@storybook/react-vite';
 2 | import { within, userEvent } from 'storybook/test';
 3 | 
 4 | import { Page } from './Page';
 5 | 
 6 | const meta: Meta<typeof Page> = {
 7 |   title: 'Example/Page',
 8 |   component: Page,
 9 |   parameters: {
10 |     // More on Story layout: https://storybook.js.org/docs/react/configure/story-layout
11 |     layout: 'fullscreen',
12 |   },
13 | };
14 | 
15 | export default meta;
16 | type Story = StoryObj<typeof Page>;
17 | 
18 | export const LoggedOut: Story = {};
19 | 
20 | // More on interaction testing: https://storybook.js.org/docs/react/writing-tests/interaction-testing
21 | export const LoggedIn: Story = {
22 |   play: async ({ canvasElement }) => {
23 |     const canvas = within(canvasElement);
24 |     const loginButton = await canvas.getByRole('button', {
25 |       name: /Log in/i,
26 |     });
27 |     await userEvent.click(loginButton);
28 |   },
29 | };
30 | 


--------------------------------------------------------------------------------
/src/stories/Button.tsx:
--------------------------------------------------------------------------------
 1 | import React from 'react';
 2 | import './button.css';
 3 | 
 4 | interface ButtonProps {
 5 |   /**
 6 |    * Is this the principal call to action on the page?
 7 |    */
 8 |   primary?: boolean;
 9 |   /**
10 |    * What background color to use
11 |    */
12 |   backgroundColor?: string;
13 |   /**
14 |    * How large should the button be?
15 |    */
16 |   size?: 'small' | 'medium' | 'large';
17 |   /**
18 |    * Button contents
19 |    */
20 |   label: string;
21 |   /**
22 |    * Optional click handler
23 |    */
24 |   onClick?: () => void;
25 | }
26 | 
27 | /**
28 |  * Primary UI component for user interaction
29 |  */
30 | export const Button = ({
31 |   primary = false,
32 |   size = 'medium',
33 |   backgroundColor,
34 |   label,
35 |   ...props
36 | }: ButtonProps) => {
37 |   const mode = primary ? 'storybook-button--primary' : 'storybook-button--secondary';
38 |   return (
39 |     <button
40 |       type="button"
41 |       className={['storybook-button', `storybook-button--${size}`, mode].join(' ')}
42 |       style={{ backgroundColor }}
43 |       {...props}
44 |     >
45 |       {label}
46 |     </button>
47 |   );
48 | };
49 | 


--------------------------------------------------------------------------------
/src/stories/Button.stories.ts:
--------------------------------------------------------------------------------
 1 | import type { Meta, StoryObj } from "@storybook/react-vite";
 2 | 
 3 | import { Button } from "./Button";
 4 | 
 5 | // More on how to set up stories at: https://storybook.js.org/docs/react/writing-stories/introduction#default-export
 6 | const meta: Meta<typeof Button> = {
 7 |   title: "Example/Button",
 8 |   component: Button,
 9 |   // More on argTypes: https://storybook.js.org/docs/react/api/argtypes
10 |   argTypes: {
11 |     backgroundColor: { control: "color" },
12 |   },
13 |   tags: ["autodocs"],
14 | };
15 | 
16 | export default meta;
17 | type Story = StoryObj<typeof Button>;
18 | 
19 | // More on component templates: https://storybook.js.org/docs/react/writing-stories/introduction#using-args
20 | export const Primary: Story = {
21 |   // More on args: https://storybook.js.org/docs/react/writing-stories/args
22 |   args: {
23 |     primary: true,
24 |     label: "Button",
25 |   },
26 | };
27 | 
28 | export const Secondary: Story = {
29 |   args: {
30 |     label: "Button",
31 |   },
32 | };
33 | 
34 | export const Large: Story = {
35 |   args: {
36 |     size: "large",
37 |     label: "Button",
38 |   },
39 | };
40 | 
41 | export const Small: Story = {
42 |   args: {
43 |     size: "small",
44 |     label: "Button",
45 |   },
46 | };
47 | 


--------------------------------------------------------------------------------
/src/stories/assets/direction.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="48" height="48" version="1.1" viewBox="0 0 48 48"><title>illustration/direction</title><g id="illustration/direction" fill="none" fill-rule="evenodd" stroke="none" stroke-width="1"><path id="Combined-Shape" fill="#FFD476" d="M23.4917015,33.6030641 L2.93840258,31.4321033 C2.38917316,31.3740904 1.99096346,30.8818233 2.04897631,30.3325939 C2.0747515,30.0885705 2.18934861,29.8625419 2.37095722,29.6975265 L34.2609105,0.721285325 C34.6696614,0.349881049 35.3021022,0.38015648 35.6735064,0.788907393 C35.9232621,1.06377731 36.0001133,1.45442096 35.8730901,1.80341447 L24.5364357,32.9506164 C24.3793473,33.3822133 23.9484565,33.6513092 23.4917015,33.6030641 L23.4917015,33.6030641 Z"/><path id="Combined-Shape-Copy" fill="#FFC445" d="M24.3163597,33.2881029 C24.0306575,33.0138462 23.9337246,32.5968232 24.069176,32.2246735 L35.091923,1.9399251 C35.2266075,1.56988243 35.5659249,1.31333613 35.9586669,1.28460955 C36.5094802,1.24432106 36.9886628,1.65818318 37.0289513,2.20899647 L40.2437557,46.1609256 C40.2644355,46.4436546 40.1641446,46.7218752 39.9678293,46.9263833 C39.5853672,47.3248067 38.9523344,47.3377458 38.5539111,46.9552837 L24.3163597,33.2881029 L24.3163597,33.2881029 Z"/></g></svg>


--------------------------------------------------------------------------------
/src/Panel.tsx:
--------------------------------------------------------------------------------
 1 | import React from "react";
 2 | import {
 3 |   useAddonState,
 4 |   useChannel,
 5 |   useParameter,
 6 | } from "storybook/internal/manager-api";
 7 | import { AddonPanel } from "storybook/internal/components";
 8 | import { ADDON_ID, EVENTS, PARAM_KEY } from "./constants";
 9 | import { PanelContent } from "./components/PanelContent";
10 | 
11 | interface PanelProps {
12 |   active: boolean;
13 | }
14 | 
15 | export const Panel: React.FC<PanelProps> = (props) => {
16 |   // https://storybook.js.org/docs/react/addons/addons-api#useaddonstate
17 |   const [{ code }, setState] = useAddonState(ADDON_ID, {
18 |     code: null,
19 |   });
20 | 
21 |   // https://storybook.js.org/docs/react/addons/addons-api#usechannel
22 |   useChannel({
23 |     [EVENTS.CODE_UPDATE]: ({ code }) => {
24 |       setState((state) => ({ ...state, code }));
25 |     },
26 |   });
27 | 
28 |   const parameters = useParameter(PARAM_KEY, {
29 |     highlighter: { showLineNumbers: false, wrapLines: true },
30 |   });
31 |   const {
32 |     highlighter: { showLineNumbers = false, wrapLines = true } = {},
33 |   } = parameters;
34 | 
35 |   return (
36 |     <AddonPanel {...props}>
37 |       <PanelContent
38 |         code={code}
39 |         showLineNumbers={showLineNumbers}
40 |         wrapLines={wrapLines}
41 |       />
42 |     </AddonPanel>
43 |   );
44 | };
45 | 


--------------------------------------------------------------------------------
/src/stories/assets/flow.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="48" height="48" version="1.1" viewBox="0 0 48 48"><title>illustration/flow</title><g id="illustration/flow" fill="none" fill-rule="evenodd" stroke="none" stroke-width="1"><path id="Combined-Shape" fill="#79C9FC" fill-rule="nonzero" d="M30,29 C32.7614237,29 35,26.7614237 35,24 C35,14.6111593 27.3888407,7 18,7 C8.61115925,7 1,14.6111593 1,24 C1,33.3888407 8.61115925,41 18,41 C19.3333404,41 20.6447683,40.8466238 21.9154603,40.5471706 C19.5096374,39.3319645 17.5510566,37.8612875 16.0456579,36.1314815 C14.1063138,33.9030427 12.769443,31.0725999 12.0293806,27.6556449 C11.360469,26.565281 11,25.3082308 11,24 C11,20.1340068 14.1340068,17 18,17 C21.8659932,17 25,20.1340068 25,24 C25,26.125 27.7040312,29 30,29 Z"/><path id="Combined-Shape-Copy" fill="#FFC445" fill-rule="nonzero" d="M42,29 C44.7614237,29 47,26.7614237 47,24 C47,14.6111593 39.3888407,7 30,7 C20.6111593,7 13,14.6111593 13,24 C13,33.3888407 20.6111593,41 30,41 C31.3333404,41 32.6447683,40.8466238 33.9154603,40.5471706 C31.5096374,39.3319645 29.4051056,37.9781963 28.0456579,36.1314815 C26.0625,33.4375 23,27.1875 23,24 C23,20.1340068 26.1340068,17 30,17 C33.8659932,17 37,20.1340068 37,24 C37.02301,26.3435241 39.7040312,29 42,29 Z" transform="translate(30.000000, 24.000000) scale(-1, -1) translate(-30.000000, -24.000000)"/></g></svg>


--------------------------------------------------------------------------------
/src/stories/page.css:
--------------------------------------------------------------------------------
 1 | section {
 2 |   font-family: "Nunito Sans", "Helvetica Neue", Helvetica, Arial, sans-serif;
 3 |   font-size: 14px;
 4 |   line-height: 24px;
 5 |   padding: 48px 20px;
 6 |   margin: 0 auto;
 7 |   max-width: 600px;
 8 |   color: #333;
 9 | }
10 | 
11 | section h2 {
12 |   font-weight: 700;
13 |   font-size: 32px;
14 |   line-height: 1;
15 |   margin: 0 0 4px;
16 |   display: inline-block;
17 |   vertical-align: top;
18 | }
19 | 
20 | section p {
21 |   margin: 1em 0;
22 | }
23 | 
24 | section a {
25 |   text-decoration: none;
26 |   color: #1ea7fd;
27 | }
28 | 
29 | section ul {
30 |   padding-left: 30px;
31 |   margin: 1em 0;
32 | }
33 | 
34 | section li {
35 |   margin-bottom: 8px;
36 | }
37 | 
38 | section .tip {
39 |   display: inline-block;
40 |   border-radius: 1em;
41 |   font-size: 11px;
42 |   line-height: 12px;
43 |   font-weight: 700;
44 |   background: #e7fdd8;
45 |   color: #66bf3c;
46 |   padding: 4px 12px;
47 |   margin-right: 10px;
48 |   vertical-align: top;
49 | }
50 | 
51 | section .tip-wrapper {
52 |   font-size: 13px;
53 |   line-height: 20px;
54 |   margin-top: 40px;
55 |   margin-bottom: 40px;
56 | }
57 | 
58 | section .tip-wrapper svg {
59 |   display: inline-block;
60 |   height: 12px;
61 |   width: 12px;
62 |   margin-right: 4px;
63 |   vertical-align: top;
64 |   margin-top: 3px;
65 | }
66 | 
67 | section .tip-wrapper svg path {
68 |   fill: #1ea7fd;
69 | }
70 | 


--------------------------------------------------------------------------------
/src/stories/assets/code-brackets.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="48" height="48" version="1.1" viewBox="0 0 48 48"><title>illustration/code-brackets</title><g id="illustration/code-brackets" fill="none" fill-rule="evenodd" stroke="none" stroke-width="1"><path id="Combined-Shape" fill="#87E6E5" d="M11.4139325,12 C11.7605938,12 12,12.5059743 12,13.3779712 L12,17.4951758 L6.43502246,23.3839989 C5.85499251,23.9978337 5.85499251,25.0021663 6.43502246,25.6160011 L12,31.5048242 L12,35.6220288 C12,36.4939606 11.7605228,37 11.4139325,37 C11.2725831,37 11.1134406,36.9158987 10.9453839,36.7379973 L0.435022463,25.6160011 C-0.145007488,25.0021663 -0.145007488,23.9978337 0.435022463,23.3839989 L10.9453839,12.2620027 C11.1134051,12.0841663 11.2725831,12 11.4139325,12 Z M36.5860675,12 C36.7274169,12 36.8865594,12.0841013 37.0546161,12.2620027 L47.5649775,23.3839989 C48.1450075,23.9978337 48.1450075,25.0021663 47.5649775,25.6160011 L37.0546161,36.7379973 C36.8865949,36.9158337 36.7274169,37 36.5860675,37 C36.2394062,37 36,36.4940257 36,35.6220288 L36,31.5048242 L41.5649775,25.6160011 C42.1450075,25.0021663 42.1450075,23.9978337 41.5649775,23.3839989 L36,17.4951758 L36,13.3779712 C36,12.5060394 36.2394772,12 36.5860675,12 Z"/><rect id="Rectangle-7-Copy-5" width="35.57" height="4" x="5.009" y="22.662" fill="#A0DB77" rx="2" transform="translate(22.793959, 24.662305) rotate(-75.000000) translate(-22.793959, -24.662305)"/></g></svg>


--------------------------------------------------------------------------------
/src/withHTML.ts:
--------------------------------------------------------------------------------
 1 | import { useChannel } from "storybook/internal/preview-api";
 2 | import type {
 3 |   Renderer,
 4 |   PartialStoryFn as StoryFunction,
 5 | } from "storybook/internal/types";
 6 | import { EVENTS } from "./constants";
 7 | import { Parameters } from "./types";
 8 | 
 9 | export const withHTML = (
10 |   storyFn: StoryFunction<Renderer>,
11 |   {
12 |     parameters: { html: parameters = {} } = {},
13 |   }: { parameters?: { html?: Parameters } },
14 | ) => {
15 |   const emit = useChannel({});
16 | 
17 |   setTimeout(() => {
18 |     const rootSelector = parameters.root || "#storybook-root, #root";
19 |     const root = document.querySelector(rootSelector);
20 |     let code: string = root ? root.innerHTML : `${rootSelector} not found.`;
21 |     const { removeEmptyComments, removeComments, transform } = parameters;
22 |     if (removeEmptyComments) {
23 |       code = code.replace(/<!--\s*-->/g, "");
24 |     }
25 |     if (removeComments === true) {
26 |       code = code.replace(/<!--[\S\s]*?-->/g, "");
27 |     } else if (removeComments instanceof RegExp) {
28 |       code = code.replace(/<!--([\S\s]*?)-->/g, (match, p1) =>
29 |         removeComments.test(p1) ? "" : match,
30 |       );
31 |     }
32 |     if (typeof transform === "function") {
33 |       try {
34 |         code = transform(code);
35 |       } catch (e) {
36 |         console.error(e);
37 |       }
38 |     }
39 |     emit(EVENTS.CODE_UPDATE, { code, options: parameters });
40 |   }, 0);
41 | 
42 |   return storyFn();
43 | };
44 | 


--------------------------------------------------------------------------------
/src/stories/assets/comments.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="48" height="48" version="1.1" viewBox="0 0 48 48"><title>illustration/comments</title><g id="illustration/comments" fill="none" fill-rule="evenodd" stroke="none" stroke-width="1"><path id="Path" fill="#96D07C" d="M2.52730803,17.9196415 C2.44329744,17.9745167 2.36370847,18.000488 2.29303375,18.000488 C2.1197031,18.000488 2,17.8443588 2,17.5752855 L2,4 C2,1.790861 3.790861,3.23296945e-13 6,3.23296945e-13 L33.9995117,3.23296945e-13 C36.2086507,3.23296945e-13 37.9995117,1.790861 37.9995117,4 L37.9995117,9.999512 C37.9995117,12.208651 36.2086507,13.999512 33.9995117,13.999512 L8,13.999512 C7.83499225,13.999512 7.6723181,13.9895206 7.51254954,13.9701099 L2.52730803,17.9196415 Z"/><path id="Path" fill="#73E1E0" d="M7.51066,44.9703679 L2.52730803,47.9186655 C2.44329744,47.9735407 2.36370847,47.999512 2.29303375,47.999512 C2.1197031,47.999512 2,47.8433828 2,47.5743095 L2,35 C2,32.790861 3.790861,31 6,31 L26,31 C28.209139,31 30,32.790861 30,35 L30,41 C30,43.209139 28.209139,45 26,45 L8,45 C7.8343417,45 7.67103544,44.9899297 7.51066,44.9703679 Z"/><path id="Path" fill="#FFD476" d="M46,19.5 L46,33.0747975 C46,33.3438708 45.8802969,33.5 45.7069663,33.5 C45.6362915,33.5 45.5567026,33.4740287 45.472692,33.4191535 L40.4887103,29.4704446 C40.3285371,29.489956 40.1654415,29.5 40,29.5 L18,29.5 C15.790861,29.5 14,27.709139 14,25.5 L14,19.5 C14,17.290861 15.790861,15.5 18,15.5 L42,15.5 C44.209139,15.5 46,17.290861 46,19.5 Z"/></g></svg>


--------------------------------------------------------------------------------
/scripts/eject-typescript.js:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env zx
 2 | 
 3 | // Copy TS files and delete src
 4 | await $`cp -r ./src ./srcTS`;
 5 | await $`rm -rf ./src`;
 6 | await $`mkdir ./src`;
 7 | 
 8 | // Install Babel and TS preset
 9 | console.log(chalk.green`
10 | 
11 | 🔃 Installing dependencies...
12 | 
13 | `);
14 | await $`npm install --save-dev @babel/cli @babel/preset-typescript --ignore-scripts`;
15 | 
16 | // Convert TS code to JS
17 | await $`babel --no-babelrc --presets @babel/preset-typescript ./srcTS -d ./src --extensions \".js,.jsx,.ts,.tsx\" --ignore "./srcTS/typings.d.ts"`;
18 | 
19 | // Format the newly created .js files
20 | console.log(chalk.green`
21 | 
22 | 💅 Format the newly created .js files...
23 | 
24 | `);
25 | await $`prettier --write ./src`;
26 | 
27 | // Add in minimal files required for the TS build setup
28 | console.log(chalk.green`
29 | 
30 | ➕ Add minimal files required for the TS build setup
31 | 
32 | `);
33 | await $`prettier --write ./src`;
34 | await $`touch ./src/dummy.ts`;
35 | await $`printf "export {};" >> ./src/dummy.ts`;
36 | 
37 | await $`touch ./src/typings.d.ts`;
38 | await $`printf 'declare module "global";' >> ./src/typings.d.ts`;
39 | 
40 | // Clean up
41 | await $`rm -rf ./srcTS`;
42 | console.log(chalk.green`
43 | 
44 | 🧹 Clean up...
45 | 
46 | `);
47 | await $`npm uninstall @babel/cli @babel/preset-typescript --ignore-scripts`;
48 | 
49 | console.log(
50 |   chalk.green.bold`
51 | TypeScript Ejection complete!`,
52 |   chalk.green`
53 | Addon code converted with JS. The TypeScript build setup is still available in case you want to adopt TypeScript in the future.
54 | `,
55 | );
56 | 


--------------------------------------------------------------------------------
/src/stories/assets/repo.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="48" height="48" version="1.1" viewBox="0 0 48 48"><title>illustration/repo</title><g id="illustration/repo" fill="none" fill-rule="evenodd" stroke="none" stroke-width="1"><path id="Rectangle-62-Copy" fill="#B7F0EF" d="M27.2217723,9.04506931 L41.2217723,6.2682098 C43.3886973,5.83840648 45.4937616,7.2466219 45.9235649,9.41354696 C45.9743993,9.66983721 46,9.93049166 46,10.1917747 L46,32.581381 C46,34.4904961 44.650862,36.1335143 42.7782277,36.5049459 L28.7782277,39.2818054 C26.6113027,39.7116087 24.5062384,38.3033933 24.0764351,36.1364682 C24.0256007,35.880178 24,35.6195235 24,35.3582405 L24,12.9686342 C24,11.0595191 25.349138,9.4165009 27.2217723,9.04506931 Z" opacity=".7"/><path id="Combined-Shape" fill="#87E6E5" d="M6.77822775,6.2682098 L20.7782277,9.04506931 C22.650862,9.4165009 24,11.0595191 24,12.9686342 L24,35.3582405 C24,37.5673795 22.209139,39.3582405 20,39.3582405 C19.738717,39.3582405 19.4780625,39.3326398 19.2217723,39.2818054 L5.22177225,36.5049459 C3.34913798,36.1335143 2,34.4904961 2,32.581381 L2,10.1917747 C2,7.98263571 3.790861,6.19177471 6,6.19177471 C6.26128305,6.19177471 6.5219375,6.21737537 6.77822775,6.2682098 Z"/><path id="Rectangle-63-Copy-2" fill="#61C1FD" d="M22,10 C23.1666667,10.2291667 24.0179036,10.625 24.5537109,11.1875 C25.0895182,11.75 25.5716146,12.875 26,14.5625 C26,29.3020833 26,37.5208333 26,39.21875 C26,40.9166667 26.4241536,42.9583333 27.2724609,45.34375 L24.5537109,41.875 L22.9824219,45.34375 C22.327474,43.1979167 22,41.2291667 22,39.4375 C22,37.6458333 22,27.8333333 22,10 Z"/></g></svg>


--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
 1 | # Contributing
 2 | 
 3 | ## Repository Structure
 4 | 
 5 | This repository makes use of [Yarn Workspaces][yarn-workspaces] to install the
 6 | dependencies for both the library itself _and_ the example applications found in
 7 | the `examples` directory.
 8 | 
 9 | You can find the source code for the library within the `addon` directory.
10 | 
11 | Example applications -- which are useful for verifying changes -- can be found
12 | within `examples`.
13 | 
14 | ## Getting Started
15 | 
16 | Once you have the repository cloned, you'll want to install the dependencies
17 | using
18 | 
19 | ```
20 | yarn install
21 | ```
22 | 
23 | This will take care of setting up everything you need to get started!
24 | 
25 | ## Building the library
26 | 
27 | The library source is found within `addon`; referenced sub-directories or
28 | commands in this section are relative to that directory.
29 | 
30 | The source-code for the library can be found within the `src` sub-directory.
31 | Babel is used to compile the output to the adjacent `out` directory, which is
32 | _not_ part of version control. This can be done by running
33 | 
34 | ```
35 | yarn build
36 | ```
37 | 
38 | Additionally, files exist within the root of the library that re-export code
39 | from the `out` directory. This allows for nice clean imports for users of the
40 | library without them needing to know about the `out` directory.
41 | 
42 | ## Running Example Apps
43 | 
44 | You can run `yarn start` from within any of the example applications to start
45 | Storybook with the library added to it. This can be helpful for checking that
46 | changes to the library look correct!
47 | 
48 | ## Publishing Releases
49 | 
50 | TBD!
51 | 
52 | [yarn-workspaces]: https://classic.yarnpkg.com/en/docs/workspaces/
53 | 


--------------------------------------------------------------------------------
/src/stories/Header.tsx:
--------------------------------------------------------------------------------
 1 | import React from 'react';
 2 | 
 3 | import { Button } from './Button';
 4 | import './header.css';
 5 | 
 6 | type User = {
 7 |   name: string;
 8 | };
 9 | 
10 | interface HeaderProps {
11 |   user?: User;
12 |   onLogin: () => void;
13 |   onLogout: () => void;
14 |   onCreateAccount: () => void;
15 | }
16 | 
17 | export const Header = ({ user, onLogin, onLogout, onCreateAccount }: HeaderProps) => (
18 |   <header>
19 |     <div className="wrapper">
20 |       <div>
21 |         <svg width="32" height="32" viewBox="0 0 32 32" xmlns="http://www.w3.org/2000/svg">
22 |           <g fill="none" fillRule="evenodd">
23 |             <path
24 |               d="M10 0h12a10 10 0 0110 10v12a10 10 0 01-10 10H10A10 10 0 010 22V10A10 10 0 0110 0z"
25 |               fill="#FFF"
26 |             />
27 |             <path
28 |               d="M5.3 10.6l10.4 6v11.1l-10.4-6v-11zm11.4-6.2l9.7 5.5-9.7 5.6V4.4z"
29 |               fill="#555AB9"
30 |             />
31 |             <path
32 |               d="M27.2 10.6v11.2l-10.5 6V16.5l10.5-6zM15.7 4.4v11L6 10l9.7-5.5z"
33 |               fill="#91BAF8"
34 |             />
35 |           </g>
36 |         </svg>
37 |         <h1>Acme</h1>
38 |       </div>
39 |       <div>
40 |         {user ? (
41 |           <>
42 |             <span className="welcome">
43 |               Welcome, <b>{user.name}</b>!
44 |             </span>
45 |             <Button size="small" onClick={onLogout} label="Log out" />
46 |           </>
47 |         ) : (
48 |           <>
49 |             <Button size="small" onClick={onLogin} label="Log in" />
50 |             <Button primary size="small" onClick={onCreateAccount} label="Sign up" />
51 |           </>
52 |         )}
53 |       </div>
54 |     </div>
55 |   </header>
56 | );
57 | 


--------------------------------------------------------------------------------
/src/stories/assets/plugin.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="48" height="48" version="1.1" viewBox="0 0 48 48"><title>illustration/plugin</title><g id="illustration/plugin" fill="none" fill-rule="evenodd" stroke="none" stroke-width="1"><path id="Combined-Shape" fill="#79C9FC" d="M26,15.3994248 C26,15.4091303 26,15.4188459 26,15.4285714 L26,21.4694881 C25.8463595,21.4969567 25.6941676,21.51275 25.5873784,21.51275 C25.4974117,21.51275 25.4230979,21.4768034 25.377756,21.4206259 L25.2660784,21.2822603 L25.1317423,21.1657666 C24.2436317,20.3956144 23.100098,19.9633214 21.895551,19.9633214 C19.2039137,19.9633214 17,22.1075558 17,24.7804643 C17,27.4533728 19.2039137,29.5976071 21.895551,29.5976071 C23.1972122,29.5976071 24.3149423,29.2878193 25.1231445,28.3613697 C25.4542273,27.9818463 25.568273,27.9073214 25.5873784,27.9073214 C25.681532,27.9073214 25.8352452,27.9239643 26,27.9524591 L26,32.5714286 C26,32.5811541 26,32.5908697 26,32.6005752 L26,33 C26,35.209139 24.209139,37 22,37 L4,37 C1.790861,37 0,35.209139 0,33 L0,15 C0,12.790861 1.790861,11 4,11 L22,11 C24.209139,11 26,12.790861 26,15 L26,15.3994248 Z"/><path id="Path" fill="#87E6E5" d="M27.9998779,32.5714286 C27.9998779,33.3604068 28.6572726,34 29.4682101,34 L46.5315458,34 C47.3424832,34 47.9998779,33.3604068 47.9998779,32.5714286 L47.9998779,15.4285714 C47.9998779,14.6395932 47.3424832,14 46.5315458,14 L29.4682101,14 C28.6572726,14 27.9998779,14.6395932 27.9998779,15.4285714 L27.9998779,21.8355216 C27.9334367,22.2650514 27.8567585,22.6454496 27.746391,22.8084643 C27.4245309,23.2838571 26.2402709,23.51275 25.5873784,23.51275 C24.8705773,23.51275 24.2322714,23.1857725 23.8214379,22.6767605 C23.3096996,22.2329909 22.6349941,21.9633214 21.895551,21.9633214 C20.2963823,21.9633214 19,23.2245992 19,24.7804643 C19,26.3363293 20.2963823,27.5976071 21.895551,27.5976071 C22.5398535,27.5976071 23.2399343,27.477727 23.6160247,27.0466112 C24.1396029,26.4464286 24.7367044,25.9073214 25.5873784,25.9073214 C26.2402709,25.9073214 27.5912951,26.1766031 27.8226692,26.6116071 C27.8819199,26.7230038 27.9403239,26.921677 27.9998779,27.1556219 L27.9998779,32.5714286 Z"/></g></svg>


--------------------------------------------------------------------------------
/src/stories/assets/stackalt.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="48" height="48" version="1.1" viewBox="0 0 48 48"><title>illustration/stackalt</title><g id="illustration/stackalt" fill="none" fill-rule="evenodd" stroke="none" stroke-width="1"><path id="Combined-Shape" fill="#FFAE00" d="M23.8628277,0 L23.8628277,48 L3.32291648,36.2491883 L3.32155653,11.9499781 L23.8628277,0 Z M23.8670509,0 L44.408322,11.9499781 L44.4069621,36.2491883 L23.8670509,48 L23.8670509,0 Z" opacity=".196"/><path id="Rectangle-46-Copy-3" fill="#66BF3C" d="M15.8232279,19.1155258 L24.7368455,21.4714881 C29.6053842,22.7582937 33.4077423,26.5606518 34.694548,31.4291905 L37.0505103,40.3428082 C37.6150232,42.4786032 36.3412474,44.6676353 34.2054524,45.2321482 C33.5569474,45.4035549 32.87575,45.4091235 32.2245294,45.2483418 L23.3459013,43.0562718 C18.2976962,41.809906 14.3561301,37.8683399 13.1097642,32.8201348 L10.9176943,23.9415066 C10.3881737,21.7967682 11.6975664,19.6288529 13.8423049,19.0993322 C14.4935255,18.9385505 15.1747229,18.9441191 15.8232279,19.1155258 Z" opacity=".5" transform="translate(23.999997, 32.166058) rotate(-45.000000) translate(-23.999997, -32.166058)"/><path id="Rectangle-46-Copy-2" fill="#FFAE00" d="M15.8232279,11.2216893 L24.7368455,13.5776516 C29.6053842,14.8644572 33.4077423,18.6668153 34.694548,23.5353541 L37.0505103,32.4489717 C37.6150232,34.5847667 36.3412474,36.7737988 34.2054524,37.3383117 C33.5569474,37.5097184 32.87575,37.515287 32.2245294,37.3545053 L23.3459013,35.1624353 C18.2976962,33.9160695 14.3561301,29.9745034 13.1097642,24.9262983 L10.9176943,16.0476701 C10.3881737,13.9029317 11.6975664,11.7350164 13.8423049,11.2054957 C14.4935255,11.044714 15.1747229,11.0502826 15.8232279,11.2216893 Z" opacity=".5" transform="translate(23.999997, 24.272222) rotate(-45.000000) translate(-23.999997, -24.272222)"/><path id="Rectangle-46-Copy" fill="#FC521F" d="M15.8232279,3.32785281 L24.7368455,5.68381509 C29.6053842,6.97062075 33.4077423,10.7729788 34.694548,15.6415176 L37.0505103,24.5551352 C37.6150232,26.6909302 36.3412474,28.8799623 34.2054524,29.4444752 C33.5569474,29.6158819 32.87575,29.6214505 32.2245294,29.4606688 L23.3459013,27.2685988 C18.2976962,26.022233 14.3561301,22.0806669 13.1097642,17.0324618 L10.9176943,8.15383364 C10.3881737,6.00909519 11.6975664,3.84117987 13.8423049,3.31165925 C14.4935255,3.15087753 15.1747229,3.15644615 15.8232279,3.32785281 Z" opacity=".5" transform="translate(23.999997, 16.378385) rotate(-45.000000) translate(-23.999997, -16.378385)"/></g></svg>


--------------------------------------------------------------------------------
/src/stories/Page.tsx:
--------------------------------------------------------------------------------
 1 | import React from 'react';
 2 | 
 3 | import { Header } from './Header';
 4 | import './page.css';
 5 | 
 6 | type User = {
 7 |   name: string;
 8 | };
 9 | 
10 | export const Page: React.FC = () => {
11 |   const [user, setUser] = React.useState<User>();
12 | 
13 |   return (
14 |     <article>
15 |       <Header
16 |         user={user}
17 |         onLogin={() => setUser({ name: 'Jane Doe' })}
18 |         onLogout={() => setUser(undefined)}
19 |         onCreateAccount={() => setUser({ name: 'Jane Doe' })}
20 |       />
21 | 
22 |       <section>
23 |         <h2>Pages in Storybook</h2>
24 |         <p>
25 |           We recommend building UIs with a{' '}
26 |           <a href="https://componentdriven.org" target="_blank" rel="noopener noreferrer">
27 |             <strong>component-driven</strong>
28 |           </a>{' '}
29 |           process starting with atomic components and ending with pages.
30 |         </p>
31 |         <p>
32 |           Render pages with mock data. This makes it easy to build and review page states without
33 |           needing to navigate to them in your app. Here are some handy patterns for managing page
34 |           data in Storybook:
35 |         </p>
36 |         <ul>
37 |           <li>
38 |             Use a higher-level connected component. Storybook helps you compose such data from the
39 |             "args" of child component stories
40 |           </li>
41 |           <li>
42 |             Assemble data in the page component from your services. You can mock these services out
43 |             using Storybook.
44 |           </li>
45 |         </ul>
46 |         <p>
47 |           Get a guided tutorial on component-driven development at{' '}
48 |           <a href="renderers/react/template/cli/ts/Page" target="_blank" rel="noopener noreferrer">
49 |             Storybook tutorials
50 |           </a>
51 |           . Read more in the{' '}
52 |           <a href="https://storybook.js.org/docs" target="_blank" rel="noopener noreferrer">
53 |             docs
54 |           </a>
55 |           .
56 |         </p>
57 |         <div className="tip-wrapper">
58 |           <span className="tip">Tip</span> Adjust the width of the canvas with the{' '}
59 |           <svg width="10" height="10" viewBox="0 0 12 12" xmlns="http://www.w3.org/2000/svg">
60 |             <g fill="none" fillRule="evenodd">
61 |               <path
62 |                 d="M1.5 5.2h4.8c.3 0 .5.2.5.4v5.1c-.1.2-.3.3-.4.3H1.4a.5.5 0 01-.5-.4V5.7c0-.3.2-.5.5-.5zm0-2.1h6.9c.3 0 .5.2.5.4v7a.5.5 0 01-1 0V4H1.5a.5.5 0 010-1zm0-2.1h9c.3 0 .5.2.5.4v9.1a.5.5 0 01-1 0V2H1.5a.5.5 0 010-1zm4.3 5.2H2V10h3.8V6.2z"
63 |                 id="a"
64 |                 fill="#999"
65 |               />
66 |             </g>
67 |           </svg>
68 |           Viewports addon in the toolbar
69 |         </div>
70 |       </section>
71 |     </article>
72 |   );
73 | };
74 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # Storybook Addon HTML
  2 | 
  3 | This addon for Storybook adds a tab that displays the compiled HTML for each
  4 | story.
  5 | 
  6 | ![Animated preview](https://raw.githubusercontent.com/whitespace-se/storybook-addon-html/master/image.gif)
  7 | 
  8 | ## Requirements
  9 | 
 10 | ### Storybook 9.x
 11 | 
 12 | Use version 8.x of this addon.
 13 | 
 14 | ### Storybook 8.x
 15 | 
 16 | Use version 7.x of this addon.
 17 | 
 18 | ## Getting Started
 19 | 
 20 | Install the addon and its dependencies.
 21 | 
 22 | With NPM:
 23 | 
 24 | ```sh
 25 | npm i --save-dev @whitespace/storybook-addon-html
 26 | ```
 27 | 
 28 | With Yarn:
 29 | 
 30 | ```sh
 31 | yarn add -D @whitespace/storybook-addon-html
 32 | ```
 33 | 
 34 | With PNPM:
 35 | 
 36 | ```sh
 37 | pnpm add -D @whitespace/storybook-addon-html
 38 | ```
 39 | 
 40 | ### Register addon
 41 | 
 42 | ```js
 43 | // .storybook/main.js
 44 | 
 45 | module.exports = {
 46 |   // ...
 47 |   addons: [
 48 |     "@whitespace/storybook-addon-html",
 49 |     // ...
 50 |   ],
 51 | };
 52 | ```
 53 | 
 54 | ## Usage
 55 | 
 56 | You can override the wrapper element selector used to grab the component HTML.
 57 | 
 58 | ```js
 59 | export const parameters = {
 60 |   html: {
 61 |     root: "#my-custom-wrapper", // default: #root
 62 |   },
 63 | };
 64 | ```
 65 | 
 66 | Some frameworks put comments inside the HTML. If you want to remove these you
 67 | can use the `removeComments` parameter. Set it to `true` to remove all comments
 68 | or set it to a regular expression that matches the content of the comments you
 69 | want to remove.
 70 | 
 71 | ```js
 72 | export const parameters = {
 73 |   html: {
 74 |     removeComments: /^\s*remove me\s*$/, // default: false
 75 |   },
 76 | };
 77 | ```
 78 | 
 79 | You can also use the `removeEmptyComments` parameter to remove only empty
 80 | comments like `<!---->` and `<!-- -->`.
 81 | 
 82 | ```js
 83 | export const parameters = {
 84 |   html: {
 85 |     removeEmptyComments: true, // default: false
 86 |   },
 87 | };
 88 | ```
 89 | 
 90 | You can override the `showLineNumbers` and `wrapLines` settings for the syntax
 91 | highlighter by using the `highlighter` parameter:
 92 | 
 93 | ```js
 94 | export const parameters = {
 95 |   html: {
 96 |     highlighter: {
 97 |       showLineNumbers: true, // default: false
 98 |       wrapLines: false, // default: true
 99 |     },
100 |   },
101 | };
102 | ```
103 | 
104 | Another way of hiding unwanted code is to define the `transform` option. It
105 | allows you to perform any change to the output code, e.g. removing attributes
106 | injected by frameworks.
107 | 
108 | ```js
109 | html: {
110 |   transform: (code) => {
111 |     // Remove attributes `_nghost` and `ng-reflect` injected by Angular:
112 |     return code.replace(/(?:_nghost|ng-reflect).*?="[\S\s]*?"/g, "");
113 |   };
114 | }
115 | ```
116 | 
117 | You can disable the HTML panel by setting the `disable` parameter to true.
118 | This will hide and disable the HTML addon in your stories.
119 | 
120 | ```js
121 | html: {
122 |   disable: true, // default: false
123 | }
124 | ```
125 | 


--------------------------------------------------------------------------------
/scripts/prepublish-checks.js:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env zx
 2 | 
 3 | import boxen from "boxen";
 4 | import dedent from "dedent";
 5 | import { readFile } from "node:fs/promises";
 6 | import { globalPackages as globalManagerPackages } from "storybook/internal/manager/globals";
 7 | import { globalPackages as globalPreviewPackages } from "storybook/internal/preview/globals";
 8 | 
 9 | const packageJson = await readFile("./package.json", "utf8").then(JSON.parse);
10 | 
11 | const name = packageJson.name;
12 | const displayName = packageJson.storybook.displayName;
13 | 
14 | let exitCode = 0;
15 | $.verbose = false;
16 | 
17 | /**
18 |  * Check that meta data has been updated
19 |  */
20 | if (name.includes("addon-kit") || displayName.includes("Addon Kit")) {
21 |   console.error(
22 |     boxen(
23 |       dedent`
24 |       ${chalk.red.bold("Missing metadata")}
25 | 
26 |       ${chalk.red(dedent`Your package name and/or displayName includes default values from the Addon Kit.
27 |       The addon gallery filters out all such addons.
28 | 
29 |       Please configure appropriate metadata before publishing your addon. For more info, see:
30 |       https://storybook.js.org/docs/react/addons/addon-catalog#addon-metadata`)}`,
31 |       { padding: 1, borderColor: "red" },
32 |     ),
33 |   );
34 | 
35 |   exitCode = 1;
36 | }
37 | 
38 | /**
39 |  * Check that README has been updated
40 |  */
41 | const readmeTestStrings =
42 |   "# Storybook Addon Kit|Click the \\*\\*Use this template\\*\\* button to get started.|https://user-images.githubusercontent.com/42671/106809879-35b32000-663a-11eb-9cdc-89f178b5273f.gif";
43 | 
44 | if ((await $`cat README.md | grep -E ${readmeTestStrings}`.exitCode) == 0) {
45 |   console.error(
46 |     boxen(
47 |       dedent`
48 |         ${chalk.red.bold("README not updated")}
49 | 
50 |         ${chalk.red(dedent`You are using the default README.md file that comes with the addon kit.
51 |         Please update it to provide info on what your addon does and how to use it.`)}
52 |       `,
53 |       { padding: 1, borderColor: "red" },
54 |     ),
55 |   );
56 | 
57 |   exitCode = 1;
58 | }
59 | 
60 | /**
61 |  * Check that globalized packages are not incorrectly listed as peer dependencies
62 |  */
63 | const peerDependencies = Object.keys(packageJson.peerDependencies || {});
64 | const globalPackages = [...globalManagerPackages, ...globalPreviewPackages];
65 | peerDependencies.forEach((dependency) => {
66 |   if (globalPackages.includes(dependency)) {
67 |     console.error(
68 |       boxen(
69 |         dedent`
70 |           ${chalk.red.bold("Unnecessary peer dependency")}
71 |   
72 |           ${chalk.red(dedent`You have a peer dependency on ${chalk.bold(dependency)} which is most likely unnecessary
73 |           as that is provided by Storybook directly.
74 |           Check the "bundling" section in README.md for more information.
75 |           If you are absolutely sure you are doing it correct, you should remove this check from scripts/prepublish-checks.js.`)}
76 |         `,
77 |         { padding: 1, borderColor: "red" },
78 |       ),
79 |     );
80 | 
81 |     exitCode = 1;
82 |   }
83 | });
84 | 
85 | process.exit(exitCode);
86 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
  1 | {
  2 |   "name": "@whitespace/storybook-addon-html",
  3 |   "version": "8.0.2",
  4 |   "description": "A Storybook addon that extracts and displays compiled syntax-highlighted HTML",
  5 |   "keywords": [
  6 |     "storybook-addon",
  7 |     "html",
  8 |     "code",
  9 |     "popular",
 10 |     "storybook-addons"
 11 |   ],
 12 |   "repository": {
 13 |     "type": "git",
 14 |     "url": "https://github.com/whitespace-se/storybook-addon-html"
 15 |   },
 16 |   "type": "module",
 17 |   "author": "Whitespace <code@whitespace.se>",
 18 |   "license": "AGPL-3.0-or-later",
 19 |   "main": "dist/cjs/index.js",
 20 |   "module": "dist/esm/index.js",
 21 |   "types": "dist/ts/index.d.ts",
 22 |   "exports": {
 23 |     ".": {
 24 |       "types": "./dist/index.d.ts",
 25 |       "import": "./dist/index.js",
 26 |       "require": "./dist/index.cjs"
 27 |     },
 28 |     "./preview": {
 29 |       "types": "./dist/index.d.ts",
 30 |       "import": "./dist/preview.js",
 31 |       "require": "./dist/preview.cjs"
 32 |     },
 33 |     "./manager": "./dist/manager.js",
 34 |     "./package.json": "./package.json"
 35 |   },
 36 |   "files": [
 37 |     "dist/**/*",
 38 |     "README.md",
 39 |     "*.js",
 40 |     "*.d.ts"
 41 |   ],
 42 |   "scripts": {
 43 |     "build": "tsup",
 44 |     "build:watch": "npm run build -- --watch",
 45 |     "test": "echo \"Error: no test specified\" && exit 1",
 46 |     "start": "run-p build:watch 'storybook --quiet'",
 47 |     "prerelease": "zx scripts/prepublish-checks.js",
 48 |     "release": "npm run build && auto shipit",
 49 |     "eject-ts": "zx scripts/eject-typescript.js",
 50 |     "storybook": "storybook dev -p 6006",
 51 |     "build-storybook": "storybook build",
 52 |     "format": "run-s format:*",
 53 |     "format:eslint": "eslint --fix '**/*.{js,jsx}' || true",
 54 |     "format:prettier": "prettier --write '**/*.{js,jsx,json,md,mdx,yml,html,css}'",
 55 |     "lint": "eslint '**/*.{js,jsx}'"
 56 |   },
 57 |   "devDependencies": {
 58 |     "@storybook/addon-docs": "^9.0.0",
 59 |     "@storybook/addon-links": "^9.0.0",
 60 |     "@storybook/react-vite": "^9.0.0",
 61 |     "@types/node": "^18.15.0",
 62 |     "@types/react": "^18.2.65",
 63 |     "@types/react-dom": "^18.2.21",
 64 |     "@vitejs/plugin-react": "^4.2.1",
 65 |     "auto": "^11.1.1",
 66 |     "boxen": "^7.1.1",
 67 |     "dedent": "^1.5.1",
 68 |     "eslint": "^8.57.0",
 69 |     "eslint-plugin-import": "^2.29.1",
 70 |     "eslint-plugin-react": "^7.34.1",
 71 |     "npm-run-all": "^4.1.5",
 72 |     "prettier": "^3.0.0",
 73 |     "prompts": "^2.4.2",
 74 |     "react": "^18.2.0",
 75 |     "react-dom": "^18.2.0",
 76 |     "storybook": "^9.0.0",
 77 |     "tsup": "^8.0.2",
 78 |     "typescript": "^5.4.2",
 79 |     "vite": "^5.1.6",
 80 |     "zx": "^7.2.3"
 81 |   },
 82 |   "peerDependencies": {
 83 |     "storybook": "^9.0.0"
 84 |   },
 85 |   "publishConfig": {
 86 |     "access": "public"
 87 |   },
 88 |   "bundler": {
 89 |     "exportEntries": [
 90 |       "src/index.ts"
 91 |     ],
 92 |     "managerEntries": [
 93 |       "src/manager.ts"
 94 |     ],
 95 |     "previewEntries": [
 96 |       "src/preview.ts"
 97 |     ],
 98 |     "nodeEntries": [
 99 |       "src/preset.ts"
100 |     ]
101 |   },
102 |   "storybook": {
103 |     "displayName": "HTML Preview",
104 |     "supportedFrameworks": [
105 |       "react",
106 |       "vue",
107 |       "angular",
108 |       "web-components",
109 |       "ember",
110 |       "html",
111 |       "svelte",
112 |       "preact",
113 |       "react-native"
114 |     ],
115 |     "icon": "https://avatars1.githubusercontent.com/u/10450088?s=400&u=b2a95469b7d2addf63366a93a17f0bd06f9894cc&v=4"
116 |   },
117 |   "overrides": {
118 |     "storybook": "$storybook"
119 |   }
120 | }
121 | 


--------------------------------------------------------------------------------
/tsup.config.ts:
--------------------------------------------------------------------------------
  1 | import { defineConfig, type Options } from "tsup";
  2 | import { readFile } from "node:fs/promises";
  3 | import { globalPackages as globalManagerPackages } from "storybook/internal/manager/globals";
  4 | import { globalPackages as globalPreviewPackages } from "storybook/internal/preview/globals";
  5 | 
  6 | // The current browsers supported by Storybook v7
  7 | const BROWSER_TARGET: Options["target"] = [
  8 |   "chrome100",
  9 |   "safari15",
 10 |   "firefox91",
 11 | ];
 12 | const NODE_TARGET: Options["target"] = ["node18"];
 13 | 
 14 | type BundlerConfig = {
 15 |   bundler?: {
 16 |     exportEntries?: string[];
 17 |     nodeEntries?: string[];
 18 |     managerEntries?: string[];
 19 |     previewEntries?: string[];
 20 |   };
 21 | };
 22 | 
 23 | export default defineConfig(async (options) => {
 24 |   // reading the three types of entries from package.json, which has the following structure:
 25 |   // {
 26 |   //  ...
 27 |   //   "bundler": {
 28 |   //     "exportEntries": ["./src/index.ts"],
 29 |   //     "managerEntries": ["./src/manager.ts"],
 30 |   //     "previewEntries": ["./src/preview.ts"]
 31 |   //     "nodeEntries": ["./src/preset.ts"]
 32 |   //   }
 33 |   // }
 34 |   const packageJson = (await readFile("./package.json", "utf8").then(
 35 |     JSON.parse,
 36 |   )) as BundlerConfig;
 37 |   const {
 38 |     bundler: {
 39 |       exportEntries = [],
 40 |       managerEntries = [],
 41 |       previewEntries = [],
 42 |       nodeEntries = [],
 43 |     } = {},
 44 |   } = packageJson;
 45 | 
 46 |   const commonConfig: Options = {
 47 |     splitting: false,
 48 |     minify: !options.watch,
 49 |     treeshake: true,
 50 |     sourcemap: true,
 51 |     clean: options.watch ? false : true,
 52 |   };
 53 | 
 54 |   const configs: Options[] = [];
 55 | 
 56 |   // export entries are entries meant to be manually imported by the user
 57 |   // they are not meant to be loaded by the manager or preview
 58 |   // they'll be usable in both node and browser environments, depending on which features and modules they depend on
 59 |   if (exportEntries.length) {
 60 |     configs.push({
 61 |       ...commonConfig,
 62 |       entry: exportEntries,
 63 |       dts: {
 64 |         resolve: true,
 65 |       },
 66 |       format: ["esm", "cjs"],
 67 |       target: [...BROWSER_TARGET, ...NODE_TARGET],
 68 |       platform: "neutral",
 69 |       external: [...globalManagerPackages, ...globalPreviewPackages],
 70 |     });
 71 |   }
 72 | 
 73 |   // manager entries are entries meant to be loaded into the manager UI
 74 |   // they'll have manager-specific packages externalized and they won't be usable in node
 75 |   // they won't have types generated for them as they're usually loaded automatically by Storybook
 76 |   if (managerEntries.length) {
 77 |     configs.push({
 78 |       ...commonConfig,
 79 |       entry: managerEntries,
 80 |       format: ["esm"],
 81 |       target: BROWSER_TARGET,
 82 |       platform: "browser",
 83 |       external: globalManagerPackages,
 84 |     });
 85 |   }
 86 | 
 87 |   // preview entries are entries meant to be loaded into the preview iframe
 88 |   // they'll have preview-specific packages externalized and they won't be usable in node
 89 |   // they'll have types generated for them so they can be imported when setting up Portable Stories
 90 |   if (previewEntries.length) {
 91 |     configs.push({
 92 |       ...commonConfig,
 93 |       entry: previewEntries,
 94 |       dts: {
 95 |         resolve: true,
 96 |       },
 97 |       format: ["esm", "cjs"],
 98 |       target: BROWSER_TARGET,
 99 |       platform: "browser",
100 |       external: globalPreviewPackages,
101 |     });
102 |   }
103 | 
104 |   // node entries are entries meant to be used in node-only
105 |   // this is useful for presets, which are loaded by Storybook when setting up configurations
106 |   // they won't have types generated for them as they're usually loaded automatically by Storybook
107 |   if (nodeEntries.length) {
108 |     configs.push({
109 |       ...commonConfig,
110 |       entry: nodeEntries,
111 |       format: ["cjs"],
112 |       target: NODE_TARGET,
113 |       platform: "node",
114 |     });
115 |   }
116 | 
117 |   return configs;
118 | });
119 | 


--------------------------------------------------------------------------------
/src/stories/Introduction.mdx:
--------------------------------------------------------------------------------
  1 | import { Meta } from "@storybook/addon-docs/blocks";
  2 | import Code from "./assets/code-brackets.svg";
  3 | import Colors from "./assets/colors.svg";
  4 | import Comments from "./assets/comments.svg";
  5 | import Direction from "./assets/direction.svg";
  6 | import Flow from "./assets/flow.svg";
  7 | import Plugin from "./assets/plugin.svg";
  8 | import Repo from "./assets/repo.svg";
  9 | import StackAlt from "./assets/stackalt.svg";
 10 | 
 11 | <Meta title="Example/Introduction" />
 12 | 
 13 | <style>
 14 |   {`
 15 |     .subheading {
 16 |       --mediumdark: '#999999';
 17 |       font-weight: 700;
 18 |       font-size: 13px;
 19 |       color: #999;
 20 |       letter-spacing: 6px;
 21 |       line-height: 24px;
 22 |       text-transform: uppercase;
 23 |       margin-bottom: 12px;
 24 |       margin-top: 40px;
 25 |     }
 26 | 
 27 |     .link-list {
 28 |       display: grid;
 29 |       grid-template-columns: 1fr;
 30 |       grid-template-rows: 1fr 1fr;
 31 |       row-gap: 10px;
 32 |     }
 33 | 
 34 |     @media (min-width: 620px) {
 35 |       .link-list {
 36 |         row-gap: 20px;
 37 |         column-gap: 20px;
 38 |         grid-template-columns: 1fr 1fr;
 39 |       }
 40 |     }
 41 | 
 42 |     @media all and (-ms-high-contrast:none) {
 43 |     .link-list {
 44 |         display: -ms-grid;
 45 |         -ms-grid-columns: 1fr 1fr;
 46 |         -ms-grid-rows: 1fr 1fr;
 47 |       }
 48 |     }
 49 | 
 50 |     .link-item {
 51 |       display: block;
 52 |       padding: 20px 30px 20px 15px;
 53 |       border: 1px solid #00000010;
 54 |       border-radius: 5px;
 55 |       transition: background 150ms ease-out, border 150ms ease-out, transform 150ms ease-out;
 56 |       color: #333333;
 57 |       display: flex;
 58 |       align-items: flex-start;
 59 |     }
 60 | 
 61 |     .link-item:hover {
 62 |       border-color: #1EA7FD50;
 63 |       transform: translate3d(0, -3px, 0);
 64 |       box-shadow: rgba(0, 0, 0, 0.08) 0 3px 10px 0;
 65 |     }
 66 | 
 67 |     .link-item:active {
 68 |       border-color: #1EA7FD;
 69 |       transform: translate3d(0, 0, 0);
 70 |     }
 71 | 
 72 |     .link-item strong {
 73 |       font-weight: 700;
 74 |       display: block;
 75 |       margin-bottom: 2px;
 76 |     }
 77 | 
 78 |     .link-item img {
 79 |       height: 40px;
 80 |       width: 40px;
 81 |       margin-right: 15px;
 82 |       flex: none;
 83 |     }
 84 | 
 85 |     .link-item span {
 86 |       font-size: 14px;
 87 |       line-height: 20px;
 88 |     }
 89 | 
 90 |     .tip {
 91 |       display: inline-block;
 92 |       border-radius: 1em;
 93 |       font-size: 11px;
 94 |       line-height: 12px;
 95 |       font-weight: 700;
 96 |       background: #E7FDD8;
 97 |       color: #66BF3C;
 98 |       padding: 4px 12px;
 99 |       margin-right: 10px;
100 |       vertical-align: top;
101 |     }
102 | 
103 |     .tip-wrapper {
104 |       font-size: 13px;
105 |       line-height: 20px;
106 |       margin-top: 40px;
107 |       margin-bottom: 40px;
108 |     }
109 | 
110 |     .tip-wrapper code {
111 |       font-size: 12px;
112 |       display: inline-block;
113 |     }
114 |   `}
115 | </style>
116 | 
117 | # Welcome to Storybook
118 | 
119 | Storybook helps you build UI components in isolation from your app's business logic, data, and context.
120 | That makes it easy to develop hard-to-reach states. Save these UI states as **stories** to revisit during development, testing, or QA.
121 | 
122 | Browse example stories now by navigating to them in the sidebar.
123 | View their code in the `stories` directory to learn how they work.
124 | We recommend building UIs with a [**component-driven**](https://componentdriven.org) process starting with atomic components and ending with pages.
125 | 
126 | <div className="subheading">Configure</div>
127 | 
128 | <div className="link-list">
129 |   <a
130 |     className="link-item"
131 |     href="https://storybook.js.org/docs/react/addons/addon-types"
132 |     target="_blank"
133 |   >
134 |     <img src={Plugin} alt="plugin" />
135 |     <span>
136 |       <strong>Presets for popular tools</strong>
137 |       Easy setup for TypeScript, SCSS and more.
138 |     </span>
139 |   </a>
140 |   <a
141 |     className="link-item"
142 |     href="https://storybook.js.org/docs/react/configure/webpack"
143 |     target="_blank"
144 |   >
145 |     <img src={StackAlt} alt="Build" />
146 |     <span>
147 |       <strong>Build configuration</strong>
148 |       How to customize webpack and Babel
149 |     </span>
150 |   </a>
151 |   <a
152 |     className="link-item"
153 |     href="https://storybook.js.org/docs/react/configure/styling-and-css"
154 |     target="_blank"
155 |   >
156 |     <img src={Colors} alt="colors" />
157 |     <span>
158 |       <strong>Styling</strong>
159 |       How to load and configure CSS libraries
160 |     </span>
161 |   </a>
162 |   <a
163 |     className="link-item"
164 |     href="https://storybook.js.org/docs/react/get-started/setup#configure-storybook-for-your-stack"
165 |     target="_blank"
166 |   >
167 |     <img src={Flow} alt="flow" />
168 |     <span>
169 |       <strong>Data</strong>
170 |       Providers and mocking for data libraries
171 |     </span>
172 |   </a>
173 | </div>
174 | 
175 | <div className="subheading">Learn</div>
176 | 
177 | <div className="link-list">
178 |   <a className="link-item" href="https://storybook.js.org/docs" target="_blank">
179 |     <img src={Repo} alt="repo" />
180 |     <span>
181 |       <strong>Storybook documentation</strong>
182 |       Configure, customize, and extend
183 |     </span>
184 |   </a>
185 |   <a
186 |     className="link-item"
187 |     href="https://storybook.js.org/tutorials/"
188 |     target="_blank"
189 |   >
190 |     <img src={Direction} alt="direction" />
191 |     <span>
192 |       <strong>In-depth guides</strong>
193 |       Best practices from leading teams
194 |     </span>
195 |   </a>
196 |   <a
197 |     className="link-item"
198 |     href="https://github.com/storybookjs/storybook"
199 |     target="_blank"
200 |   >
201 |     <img src={Code} alt="code" />
202 |     <span>
203 |       <strong>GitHub project</strong>
204 |       View the source and add issues
205 |     </span>
206 |   </a>
207 |   <a className="link-item" href="https://discord.gg/storybook" target="_blank">
208 |     <img src={Comments} alt="comments" />
209 |     <span>
210 |       <strong>Discord chat</strong>
211 |       Chat with maintainers and the community
212 |     </span>
213 |   </a>
214 | </div>
215 | 
216 | <div className="tip-wrapper">
217 |   <span className="tip">Tip</span>Edit the Markdown in{" "}
218 |   <code>stories/Introduction.stories.mdx</code>
219 | </div>
220 | 


--------------------------------------------------------------------------------
/src/stories/assets/colors.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="48" height="48" version="1.1" viewBox="0 0 48 48"><title>illustration/colors</title><g id="illustration/colors" fill="none" fill-rule="evenodd" stroke="none" stroke-width="1"><circle id="Oval" cx="23.763" cy="16.192" r="13.271" fill="#FC521F" opacity=".6"/><circle id="Oval-Copy" cx="15.468" cy="32.308" r="13.271" fill="#66BF3C" opacity=".6"/><path id="Combined-Shape" fill="#FF5F95" d="M15.4683651,19.0362231 C21.5434817,19.0362231 26.6652087,23.1181689 28.2404554,28.6889694 C26.8420385,29.1906678 25.3344184,29.4637769 23.7630101,29.4637769 C17.6878936,29.4637769 12.5661666,25.3818311 10.9909199,19.8110306 C12.3898993,19.3092302 13.8972501,19.0362231 15.4683651,19.0362231 Z"/><circle id="Oval-Copy-2" cx="32.532" cy="32.308" r="13.271" fill="#1EA7FD" opacity=".6"/><path id="Combined-Shape" fill="#87E6E5" d="M24.00025,22.1417324 C26.897967,24.5762286 28.7397972,28.2268506 28.7397972,32.3076552 C28.7397972,36.3884597 26.897967,40.0390817 24.00025,42.4735779 C21.1018087,40.038637 19.2602028,36.3882111 19.2602028,32.3076552 C19.2602028,28.2815316 21.0530043,24.6741393 23.8838362,22.2402492 Z"/><path id="Combined-Shape" fill="#FBD178" d="M32.5316349,19.0362231 C33.9415155,19.0362231 35.3000478,19.2560712 36.5748203,19.6633557 C35.0489179,25.3104816 29.8909911,29.4637769 23.7630101,29.4637769 C22.3527608,29.4637769 20.9938866,29.2438138 19.7188247,28.8363247 C21.2451195,23.1900077 26.403293,19.0362231 32.5316349,19.0362231 Z"/><path id="Combined-Shape" fill="#FFF" d="M24.00025,22.1417324 L24.0124326,22.1519799 C24.1747744,22.288701 24.3337918,22.4292434 24.4893463,22.5734686 L24.3896855,22.4820008 C24.4671836,22.552408 24.5438453,22.6237194 24.619654,22.6959185 L24.4893463,22.5734686 C24.5690639,22.6473803 24.6478719,22.7222591 24.7257519,22.7980864 L24.619654,22.6959185 C24.6907654,22.7636441 24.7611262,22.8321506 24.8307226,22.9014245 L24.7257519,22.7980864 C24.8120661,22.8821258 24.8972403,22.9673303 24.981249,23.0536745 L24.8307226,22.9014245 C24.9073006,22.9776475 24.9829531,23.0547994 25.0576619,23.132862 L25.057852,23.1330605 C25.3140855,23.4007967 25.559391,23.679459 25.7928375,23.9681079 L25.7230574,23.8825538 C25.7985998,23.9743942 25.8729325,24.0672672 25.9460311,24.1611484 L25.7928375,23.9681079 C25.8624256,24.0541514 25.93096,24.1410823 25.998421,24.228881 L25.9460311,24.1611484 C26.0074362,24.2400115 26.0679704,24.319586 26.1276194,24.3998576 L25.998421,24.228881 C26.0663495,24.317288 26.1331896,24.4065749 26.1989214,24.4967216 L26.1276194,24.3998576 C26.204848,24.5037867 26.2805926,24.6088841 26.3548219,24.7151187 L26.1989214,24.4967216 C26.2678555,24.59126 26.3355706,24.6867441 26.4020436,24.7831507 L26.3548219,24.7151187 C26.4130013,24.798383 26.4702498,24.8823459 26.5265523,24.9669921 L26.4020436,24.7831507 C26.4678788,24.8786322 26.5324956,24.9750187 26.5958716,25.0722875 L26.5959296,25.0723765 C26.736338,25.2878741 26.870709,25.5077955 26.9987399,25.7318073 L26.9410662,25.6319089 C26.9973106,25.7283602 27.0523736,25.8255849 27.1062352,25.9235633 L26.9987399,25.7318073 C27.0539848,25.8284676 27.1080492,25.9258895 27.1609136,26.0240532 L27.1606656,26.0235927 C27.2696676,26.2259984 27.3733426,26.4310837 27.4717677,26.6391379 L27.4715275,26.6386302 C27.5541941,26.8133735 27.6329386,26.9896914 27.7079006,27.1679911 C27.7630163,27.299081 27.8161443,27.431391 27.8671831,27.5647345 L27.804312,27.4036517 C27.8391482,27.4912057 27.8730792,27.5792182 27.9060936,27.6676774 L27.8671831,27.5647345 C27.906613,27.6677486 27.9447959,27.7713796 27.9817136,27.8756091 L27.9060936,27.6676774 C27.946474,27.7758735 27.9854831,27.884738 28.0230997,27.9942498 L27.9817136,27.8756091 C28.0144978,27.9681688 28.0462842,28.0612004 28.0770597,28.1546911 L28.0230997,27.9942498 C28.0618265,28.1069941 28.0990774,28.2204244 28.1348294,28.3345177 L28.0770597,28.1546911 C28.1112208,28.2584663 28.1441365,28.3628071 28.175789,28.4676958 L28.1756797,28.4673338 L28.2408136,28.6893554 C28.2284694,28.6937793 28.2161167,28.6981854 28.2037557,28.7025737 L28.2404554,28.6889694 C27.9517707,28.7925384 27.6584322,28.8863659 27.3608394,28.97006 L27.3609965,28.9702524 C27.0695498,29.0519815 26.7741843,29.1241944 26.4751174,29.1863314 L26.5385665,29.1730829 C26.3901218,29.2046704 26.2407589,29.2337757 26.0905233,29.2603535 L26.4751174,29.1863314 C26.3367402,29.215082 26.1975707,29.2416755 26.0576458,29.2660754 L26.0905233,29.2603535 C25.9366833,29.2875689 25.7819282,29.312134 25.6263069,29.334 L26.0576458,29.2660754 C25.9017815,29.2932549 25.7449801,29.3177127 25.5872928,29.3393985 L25.6263069,29.334 C25.493366,29.3526793 25.3597929,29.3693888 25.2256182,29.3840982 L25.5872928,29.3393985 C25.4326976,29.360659 25.277251,29.3792552 25.1210012,29.3951396 L25.2256182,29.3840982 C25.0570566,29.4025774 24.8875455,29.4178998 24.7171453,29.4300052 L25.1210012,29.3951396 C24.9661341,29.4108835 24.810478,29.4239634 24.6540799,29.4343333 L24.7171453,29.4300052 C24.5612618,29.4410793 24.4046342,29.4494611 24.2473088,29.4551045 L24.6540799,29.4343333 C24.5098436,29.4438967 24.3649762,29.4511552 24.2195147,29.4560724 L24.2473088,29.4551045 C24.0865878,29.4608697 23.9251385,29.4637769 23.7630101,29.4637769 L23.3130142,29.4562912 C23.2993121,29.4558347 23.2856153,29.4553574 23.2719237,29.4548593 C22.9596275,29.4434959 22.6502324,29.4213577 22.3439491,29.3888006 L22.3886972,29.3934808 C22.2468147,29.3788837 22.105595,29.3620515 21.9650736,29.3430199 L22.3439491,29.3888006 C22.1914515,29.3725905 22.0397254,29.3537976 21.8888152,29.3324664 L21.9650736,29.3430199 C21.8025527,29.3210088 21.6409661,29.2960557 21.4803691,29.2682161 L21.8888152,29.3324664 C21.7352182,29.3107553 21.5824665,29.2864149 21.4306071,29.2594919 L21.4803691,29.2682161 C21.3506285,29.2457255 21.2215338,29.221351 21.0931142,29.1951218 L21.4306071,29.2594919 C21.2772401,29.2323016 21.1247833,29.2024774 20.973285,29.1700676 L21.0931142,29.1951218 C20.9267071,29.1611338 20.7614335,29.1240315 20.5973571,29.0838786 L20.973285,29.1700676 C20.825476,29.138447 20.6785795,29.1043653 20.5326403,29.0678674 L20.5973571,29.0838786 C20.4596684,29.0501832 20.3228227,29.0143396 20.1868576,28.9763851 L20.5326403,29.0678674 C20.3930822,29.0329653 20.2543997,28.9958536 20.1166319,28.9565718 L20.1169729,28.956669 L19.7188247,28.8363247 L19.7188247,28.8363247 L19.7880988,28.5894836 C19.8166627,28.4914193 19.8463277,28.3938241 19.8770797,28.2967124 L19.8480041,28.389868 C19.888904,28.2573207 19.931824,28.1256601 19.9767281,27.9949221 L19.8770797,28.2967124 C19.9117081,28.1873592 19.9477148,28.0786191 19.9850793,27.9705124 L19.9853117,27.9700125 C20.1152243,27.5939638 20.2618428,27.2250995 20.4240731,26.8647811 L20.345088,27.0439391 C20.3899401,26.9402428 20.4360767,26.8372321 20.4834778,26.7349269 L20.4240731,26.8647811 C20.461061,26.78263 20.4988604,26.7009231 20.5374612,26.6196707 L20.4834778,26.7349269 C20.5344734,26.6248636 20.5869326,26.515617 20.6408302,26.4072119 L20.5374612,26.6196707 C20.5871241,26.5151329 20.6381134,26.4113474 20.6904074,26.308336 L20.6408302,26.4072119 C20.681671,26.3250682 20.7233378,26.2434076 20.7658197,26.1622412 L20.7658807,26.1619302 C20.8435258,26.013775 20.923959,25.866962 21.0070529,25.7218685 C21.2050227,25.3759931 21.4182299,25.0398756 21.6456589,24.7144306 L21.5286537,24.8848257 C21.5876708,24.7975143 21.6476996,24.7109431 21.7087233,24.6251289 L21.6456589,24.7144306 C21.6993229,24.6376387 21.7537788,24.5614411 21.8090146,24.4858495 L21.7087233,24.6251289 C21.7826333,24.5211934 21.8580028,24.4183683 21.9348018,24.3166836 L21.8090146,24.4858495 C21.8722751,24.3992759 21.9365587,24.3134973 22.0018475,24.2285315 L22.0016895,24.2288802 C22.3179789,23.8171232 22.6576794,23.4247699 23.0189296,23.053491 L22.8296293,23.2521975 C22.9033796,23.1732135 22.9780829,23.095131 23.0537208,23.0179683 L23.0189296,23.053491 C23.083529,22.9870982 23.1488175,22.9213793 23.2147836,22.8563459 L23.0537208,23.0179683 C23.131055,22.9390752 23.2093662,22.8611436 23.2886348,22.7841931 L23.2147836,22.8563459 C23.2821211,22.7899605 23.3501645,22.7242893 23.4189017,22.6593447 L23.2886348,22.7841931 C23.3852399,22.6904132 23.4832671,22.5980904 23.582681,22.5072602 L23.4189017,22.6593447 C23.4912637,22.5909753 23.5643945,22.523411 23.6382797,22.4566663 L23.582681,22.5072602 C23.6715916,22.4260264 23.7616113,22.3459865 23.8527148,22.2671658 L23.8525967,22.2671923 C23.8915062,22.2336043 23.9304941,22.2002638 23.9696766,22.1671464 L24.00025,22.1417324 Z"/></g></svg>


--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
  1 | ### [8.0.2](https://github.com/whitespace-se/storybook-addon-html/compare/v8.0.1...v8.0.2) (2025-08-29)
  2 | 
  3 | 
  4 | ### Bug Fixes
  5 | 
  6 | * Wrong Storybook peer dep version ([70fa4cf](https://github.com/whitespace-se/storybook-addon-html/commit/70fa4cf3e8eedc9b5ce9737e0c1f6965ebc7367d))
  7 | 
  8 | ### [8.0.1](https://github.com/whitespace-se/storybook-addon-html/compare/v8.0.0...v8.0.1) (2025-08-28)
  9 | 
 10 | ## [8.0.0](https://github.com/whitespace-se/storybook-addon-html/compare/v7.0.0...v8.0.0) (2025-08-28)
 11 | 
 12 | 
 13 | ### ⚠ BREAKING CHANGES
 14 | 
 15 | * Support Storybook 9
 16 | 
 17 | ### Features
 18 | 
 19 | * Support Storybook 9 ([68f6df1](https://github.com/whitespace-se/storybook-addon-html/commit/68f6df103ee58966e0d6393e18c8928c1ae1f3bd))
 20 | 
 21 | ## [7.0.0](https://github.com/whitespace-se/storybook-addon-html/compare/v6.1.1...v7.0.0) (2025-05-07)
 22 | 
 23 | 
 24 | ### ⚠ BREAKING CHANGES
 25 | 
 26 | * Refactor the code to use the syntax highlighter of Storybook (#137)
 27 | 
 28 | ### Code Refactoring
 29 | 
 30 | * Refactor the code to use the syntax highlighter of Storybook ([#137](https://github.com/whitespace-se/storybook-addon-html/issues/137)) ([ad191ec](https://github.com/whitespace-se/storybook-addon-html/commit/ad191ec7385fea6ec7017eb30585ec7c6e47089d))
 31 | 
 32 | ### [6.1.1](https://github.com/whitespace-se/storybook-addon-html/compare/v6.1.0...v6.1.1) (2024-05-11)
 33 | 
 34 | 
 35 | ### Bug Fixes
 36 | 
 37 | * update syntax-highlighter language option and correct type reference ([#126](https://github.com/whitespace-se/storybook-addon-html/issues/126)) ([a653292](https://github.com/whitespace-se/storybook-addon-html/commit/a653292b8bac979d51ca7b48c956b6fe783b9b4f))
 38 | 
 39 | ## [6.1.0](https://github.com/whitespace-se/storybook-addon-html/compare/v6.0.5...v6.1.0) (2024-05-07)
 40 | 
 41 | 
 42 | ### Features
 43 | 
 44 | * add `paramKey` property to panel object. ([#120](https://github.com/whitespace-se/storybook-addon-html/issues/120)) ([1506cad](https://github.com/whitespace-se/storybook-addon-html/commit/1506cad8482a03959e585c7cd8dbe86c4dd16fde))
 45 | 
 46 | ### [6.0.5](https://github.com/whitespace-se/storybook-addon-html/compare/v6.0.4...v6.0.5) (2024-04-11)
 47 | 
 48 | 
 49 | ### Bug Fixes
 50 | 
 51 | * Remove unused preset file ([2a8299d](https://github.com/whitespace-se/storybook-addon-html/commit/2a8299d196fa3e19954bc30e9875aee230640cd1))
 52 | 
 53 | ### [6.0.4](https://github.com/whitespace-se/storybook-addon-html/compare/v6.0.3...v6.0.4) (2024-04-02)
 54 | 
 55 | ### [6.0.3](https://github.com/whitespace-se/storybook-addon-html/compare/v6.0.2...v6.0.3) (2024-04-02)
 56 | 
 57 | 
 58 | ### Bug Fixes
 59 | 
 60 | * Replace all instances of "my addon" ([693c60e](https://github.com/whitespace-se/storybook-addon-html/commit/693c60eb28c802c330d0c184aa3fd53c0a4295d5))
 61 | 
 62 | ### [6.0.2](https://github.com/whitespace-se/storybook-addon-html/compare/v6.0.1...v6.0.2) (2024-03-25)
 63 | 
 64 | 
 65 | ### Bug Fixes
 66 | 
 67 | * Remove reference to preset ([f7997e8](https://github.com/whitespace-se/storybook-addon-html/commit/f7997e82f10aec49a5e716584c0c03cd44a0ddbe))
 68 | 
 69 | ### [6.0.1](https://github.com/whitespace-se/storybook-addon-html/compare/6.0.0...v6.0.1) (2024-03-25)
 70 | 
 71 | ## [6.0.0](https://github.com/whitespace-se/storybook-addon-html/compare/v5.1.4...6.0.0) (2024-03-25)
 72 | 
 73 | 
 74 | ### ⚠ BREAKING CHANGES
 75 | 
 76 | * Rewrite in Typescript with support for Storybook 8 and Prettier 3 based on latest addon kit
 77 | 
 78 | ### Code Refactoring
 79 | 
 80 | * Rewrite in Typescript with support for Storybook 8 and Prettier 3 based on latest addon kit ([4963646](https://github.com/whitespace-se/storybook-addon-html/commit/4963646a1b08eeb19cda90c36d036c11921060c0))
 81 | 
 82 | ### [5.1.4](https://github.com/whitespace-se/storybook-addon-html/compare/v5.1.3...v5.1.4) (2023-03-13)
 83 | 
 84 | 
 85 | ### Bug Fixes
 86 | 
 87 | * Incompatibility with Storybook 7.0 ([4751ec7](https://github.com/whitespace-se/storybook-addon-html/commit/4751ec73ff55cd9fb7a7a4e452ae8524e42797be))
 88 | 
 89 | ### [5.1.3](https://github.com/whitespace-se/storybook-addon-html/compare/v5.1.2...v5.1.3) (2023-03-10)
 90 | 
 91 | ### [5.1.2](https://github.com/whitespace-se/storybook-addon-html/compare/v5.1.1...v5.1.2) (2023-03-10)
 92 | 
 93 | 
 94 | ### Bug Fixes
 95 | 
 96 | * Replace removed hljs theme ([d7204aa](https://github.com/whitespace-se/storybook-addon-html/commit/d7204aa57f66e102ea19719786c29a7115d97a8e))
 97 | 
 98 | ### [5.1.1](https://github.com/whitespace-se/storybook-addon-html/compare/v5.1.0...v5.1.1) (2022-12-15)
 99 | 
100 | 
101 | ### Bug Fixes
102 | 
103 | * Outdated peer dep ([81e74f6](https://github.com/whitespace-se/storybook-addon-html/commit/81e74f658b8e60e691a6631061960fc130a187d0))
104 | 
105 | ## [5.1.0](https://github.com/whitespace-se/storybook-addon-html/compare/v5.0.3...v5.1.0) (2022-12-09)
106 | 
107 | 
108 | ### Features
109 | 
110 | * Add transform option for custom manipulation ([e7a35b8](https://github.com/whitespace-se/storybook-addon-html/commit/e7a35b87e9afc8d377460ee131c9501a14810b97))
111 | 
112 | 
113 | ### Bug Fixes
114 | 
115 | * Match multiline comments ([c23952b](https://github.com/whitespace-se/storybook-addon-html/commit/c23952b75f0e471fd5c50d1a94a5540a9c6c7ad2))
116 | 
117 | 
118 | ### Reverts
119 | 
120 | * Revert "ci: Remove autoit/conventional-commits" ([74628b2](https://github.com/whitespace-se/storybook-addon-html/commit/74628b2b3be2abe3bce0d7137e63a9ca1aea87a6))
121 | 
122 | ### [5.0.3](https://github.com/whitespace-se/storybook-addon-html/compare/v5.0.2...v5.0.3) (2022-11-11)
123 | 
124 | ### [5.0.2](https://github.com/whitespace-se/storybook-addon-html/compare/v5.0.1...v5.0.2) (2022-11-11)
125 | 
126 | 
127 | ### Features
128 | 
129 | * Add `removeComments` option ([5b4a6e6](https://github.com/whitespace-se/storybook-addon-html/commit/5b4a6e6cef0c53b528903eefd3bebd23963e4aa1)), closes [#73](https://github.com/whitespace-se/storybook-addon-html/issues/73) [#64](https://github.com/whitespace-se/storybook-addon-html/issues/64)
130 | 
131 | ### [5.0.1](https://github.com/whitespace-se/storybook-addon-html/compare/v5.0.0...v5.0.1) (2022-11-11)
132 | 
133 | 
134 | ### ⚠ BREAKING CHANGES
135 | 
136 | * Complete rewrite based on the official addon kit structure
137 | 
138 | ### Code Refactoring
139 | 
140 | * Complete rewrite based on the official addon kit structure ([836d4b9](https://github.com/whitespace-se/storybook-addon-html/commit/836d4b97bdbe52a321210e7d612c53b4f3c0c771))
141 | 
142 | ## [5.0.0](https://github.com/whitespace-se/storybook-addon-html/compare/v4.2.0...v5.0.0) (2021-03-26)
143 | 
144 | ## [4.2.0](https://github.com/whitespace-se/storybook-addon-html/compare/v4.1.0...v4.2.0) (2021-01-07)
145 | 
146 | 
147 | ### Features
148 | 
149 | * allow empty comments to be removed ([5cf46c0](https://github.com/whitespace-se/storybook-addon-html/commit/5cf46c0a1ff31ae4cf4e5b9a000436368e8df77c))
150 | * allow overriding `showLineNumbers` and `wrapLines` for the highlighter ([121ffb6](https://github.com/whitespace-se/storybook-addon-html/commit/121ffb6260f5f1567d612a8f616d300dec53ed66)), closes [#21](https://github.com/whitespace-se/storybook-addon-html/issues/21)
151 | 
152 | ## [4.1.0](https://github.com/whitespace-se/storybook-addon-html/compare/v4.0.2...v4.1.0) (2021-01-07)
153 | 
154 | ### [4.0.2](https://github.com/whitespace-se/storybook-addon-html/compare/v4.0.1...v4.0.2) (2020-12-14)
155 | 
156 | ### [4.0.1](https://github.com/whitespace-se/storybook-addon-html/compare/v4.0.0...v4.0.1) (2020-12-11)
157 | 
158 | 
159 | ### Bug Fixes
160 | 
161 | * show error message when trying to import framework-specific module ([1ef9e1b](https://github.com/whitespace-se/storybook-addon-html/commit/1ef9e1b68f7757558de8d25e47b50dcc8a96b5d7)), closes [#31](https://github.com/whitespace-se/storybook-addon-html/issues/31)
162 | 
163 | ## [4.0.0](https://github.com/whitespace-se/storybook-addon-html/compare/v3.0.0...v4.0.0) (2020-12-10)
164 | 
165 | 
166 | ### ⚠ BREAKING CHANGES
167 | 
168 | * add preset and support for att frameworks
169 | 
170 | ### Features
171 | 
172 | * add preset and support for att frameworks ([51a33c8](https://github.com/whitespace-se/storybook-addon-html/commit/51a33c8b23870dd47ac899b98fb92427329ab971))
173 | 
174 | 
175 | ### Bug Fixes
176 | 
177 | * assign peer deps ([ae0dabc](https://github.com/whitespace-se/storybook-addon-html/commit/ae0dabc8f316612a9dfa4fe50062667b90643416))
178 | * **examples/react:** simplify Whitespace logo ([4884b04](https://github.com/whitespace-se/storybook-addon-html/commit/4884b0490c081104d896db7e7afdcf92fe893ffb))
179 | * re-add support for options via parameters ([ed19b93](https://github.com/whitespace-se/storybook-addon-html/commit/ed19b93ec6c7f3776e5e16866c7a87694d6ec758))
180 | 
181 | ## [3.0.0](https://github.com/whitespace-se/storybook-addon-html/compare/v2.0.1...v3.0.0) (2020-12-09)
182 | 
183 | ### [2.0.1](https://github.com/whitespace-se/storybook-addon-html/compare/v2.0.0...v2.0.1) (2020-09-09)
184 | 
185 | ## [2.0.0](https://github.com/whitespace-se/storybook-addon-html/compare/v1.2.2...v2.0.0) (2020-08-21)
186 | 
187 | 
188 | ### ⚠ BREAKING CHANGES
189 | 
190 | * **deps:** Minimum supported Storybook version is now 6.X.X
191 | 
192 | ### Bug Fixes
193 | 
194 | * ensure code is shown on first render ([0f033b8](https://github.com/whitespace-se/storybook-addon-html/commit/0f033b8c77178d18e700cd5f105b1fa336a65d51))
195 | * pin “Copy” button to bottom of panel ([ed0c7d4](https://github.com/whitespace-se/storybook-addon-html/commit/ed0c7d43b236427fb66995256972a31807a98d7b))
196 | 
197 | 
198 | ### Miscellaneous Chores
199 | 
200 | * **deps:** upgrade to support Storybook 6 ([2b049c9](https://github.com/whitespace-se/storybook-addon-html/commit/2b049c9de87216cedd399876a7bcb38770ef9e40))
201 | 
202 | ### [1.2.2](https://github.com/whitespace-se/storybook-addon-html/compare/v1.2.0...v1.2.2) (2020-05-09)
203 | 
204 | ## 1.2.0 (2020-01-07)
205 | 
206 | 


--------------------------------------------------------------------------------