Narcoleptic's Patch Mangler

    storybook-preset-craco

    0.0.6 • Public • Published

    Craco preset for Storybook

    One-line craco configuration for Storybook.

    This preset is designed to use alongside @storybook/react.

    🛠 Installing

    Yarn

    yarn add storybook-preset-craco
    

    npm

    npm i storybook-preset-craco
    

    🎓 Usage

    Basic

    First, install this preset to your project.

    # Yarn
    yarn add -D storybook-preset-craco
    
    # npm
    npm install -D storybook-preset-craco

    Once installed, add this preset to the appropriate file:

    • ./.storybook/main.js

      module.exports = {
        addons: ["storybook-preset-craco"],
      };

      Note: Don't forget to comment or remove the @storybook/preset-create-react-app from addons.

    Usage with Docs

    When working with Storybook Docs, simply add the following config to your main.js file.

    module.exports = {
      addons: [
        "storybook-preset-craco",
        {
          name: "@storybook/addon-docs",
          options: {
            configureJSX: true,
          },
        },
      ],
    };

    Custom craco.config.js

    In most cases, this preset will look for your craco.config.js in the current working directory.

    If you are using a non standard project layout then you can provide it in cracoConfigFile.

    module.exports = {
      addons: [
        {
          name: "storybook-preset-craco",
          options: {
            cracoConfigFile: "../craco.config.js",
          },
        },
      ],
    };

    ⚖️ Licence

    This project is licensed under the MIT licence.

    All documentation and images are licenced under the Creative Commons Attribution-ShareAlike 4.0 International License.

    📝 Meta

    This project uses Semantic Versioning.

    Keywords

    none

    Install

    npm i storybook-preset-craco

    DownloadsWeekly Downloads

    9,206

    Version

    0.0.6

    License

    MIT

    Unpacked Size

    15.8 kB

    Total Files

    8

    Last publish

    Collaborators

    • danielknell