JSPM

storybook

0.0.0-pr-28415-sha-98c4ca6f
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 6669178
  • Score
    100M100P100Q186373F
  • License MIT

Storybook's CLI - install, dev, build, upgrade, and more

Package Exports

  • storybook
  • storybook/bin/index.cjs
  • storybook/core
  • storybook/core-path
  • storybook/internal/builder-manager
  • storybook/internal/channels
  • storybook/internal/client-logger
  • storybook/internal/common
  • storybook/internal/components
  • storybook/internal/core-events
  • storybook/internal/core-server
  • storybook/internal/core-server/presets/common-manager
  • storybook/internal/core-server/presets/common-override-preset
  • storybook/internal/core-server/presets/common-preset
  • storybook/internal/csf-tools
  • storybook/internal/docs-tools
  • storybook/internal/manager-api
  • storybook/internal/manager-errors
  • storybook/internal/manager/globals-module-info
  • storybook/internal/node-logger
  • storybook/internal/preview-api
  • storybook/internal/preview-errors
  • storybook/internal/preview/globals
  • storybook/internal/router
  • storybook/internal/server-errors
  • storybook/internal/telemetry
  • storybook/internal/theming
  • storybook/internal/theming/create
  • storybook/internal/types
  • storybook/package.json

Readme

Storybook

CLI

Storybook CLI (Command Line Interface) is the easiest way to add Storybook to your project.

Screenshot

Go to your project and run:

cd my-app
npx sb@latest init

In addition to init, the CLI also has other commands:

  • add - add an addon and register it
  • info - print out system information for bug reports
  • upgrade - upgrade to the latest version of Storybook (or a specific version)
  • migrate - run codemods to migrate your code

See the command-line help with -h (including other useful commands) for details.

Core APIs

This package has multiple sub-exports to can be used to gain access to storybook's APIs.

storybook/components

This export contains a list of components very useful for building out addons. We recommend addon-authors to use these components to ensure a consistent look and feel, and to reduce the amount of code they need to write.

storybook/theming

This export exposes a few utility functions to help writing components that automatically adapt to the current theme. Useful for addon authors who want to make their addons theme-aware.

storybook/preview-api

This export contains the API that is available in the preview iframe.

storybook/manager-api

This export contains the API that is available in the manager iframe.

storybook/types

This export exposes a lot of TypeScript interfaces used throughout storybook, including for storybook configuration, addons etc.