Needful Program Management

    @dgonzalezr/storybook-addon-html

    5.0.0 • Public • Published

    Storybook Addon HTML

    This addon for Storybook adds a tab that displays the compiled HTML for each story. It uses highlight.js for syntax highlighting.

    Animated preview

    Getting Started

    With NPM:

    npm i --save-dev @dgonzalezr/storybook-addon-html

    With Yarn:

    yarn add -D @dgonzalezr/storybook-addon-html

    Register addon

    // .storybook/main.js
    
    module.exports = {
      // ...
      addons: [
        '@dgonzalezr/storybook-addon-html',
        // ...
      ],
    };

    Usage

    The HTML is formatted with Prettier. You can override the Prettier config (except parser and plugins) by providing an object following the Prettier API override format in the html parameter:

    // .storybook/preview.js
    
    export const parameters = {
      // ...
      html: {
        prettier: {
          tabWidth: 4,
          useTabs: false,
          htmlWhitespaceSensitivity: 'strict',
        },
      },
    };

    You can override the wrapper element selector used to grab the component HTML.

    export const parameters = {
      html: {
        root: '#my-custom-wrapper', // default: #root
      },
    };

    When using Web Components, the HTML will contain empty comments, i.e. <!---->, or <!--..lit$..--> if using lit-html. If you want to remove these, use the removeComments parameter:

    export const parameters = {
      html: {
        removeComments: true, // default: false
      },
    };

    you can also provide your own regular expression to remove specific HTML comments:

    export const parameters = {
      html: {
        // Remove only lit HTML comments, eg: `<!--?lit$117057236$-->`
        removeComments: /<!--(.lit.*?)-->/g, 
      },
    };

    You can override the showLineNumbers and wrapLines settings for the syntax highlighter by using the highlighter parameter:

    export const parameters = {
      html: {
        highlighter: {
          showLineNumbers: true, // default: false
          wrapLines: false, // default: true
        },
      },
    };

    Supported frameworks

    As of version 4.0.0 all frameworks are supported per default 🎉

    Install

    npm i @dgonzalezr/storybook-addon-html

    DownloadsWeekly Downloads

    89

    Version

    5.0.0

    License

    AGPL

    Unpacked Size

    16.5 kB

    Total Files

    17

    Last publish

    Collaborators

    • dgonzalezr