@storybook/csf NPM | npm.io

0.1.4 • Published 8 days ago

Install

Weekly downloads

1,939,926

License

MIT

Repository

Last release

8 days ago

Storybook Component Story Format (CSF)

A minimal set of utility functions for dealing with Storybook Component Story Format (CSF).

Install

yarn add @storybook/csf

API

See package source for function definitions and types:

storyNameFromExport(key) - Enhance export name (key) of the story. Currently implemented with startCase.
isExportStory(key, { includeStories, excludeStories }) - Does a named export match CSF inclusion/exclusion options?
parseKind(kind, { rootSeparator, groupSeparator }) - Parse out the component/kind name from a path, using the given separator config.
sanitize(string) - Remove punctuation and illegal characters from a story ID.
toId(kind, name) - Generate a storybook ID from a component/kind and story name.

Contributing

If you have any suggestions, please open an issue or a PR.

All contributions are welcome!

run tests:

yarn test

storybook component story format csf stories

@storybook/components @storybook/addon-links @storybook/source-loader @storybook/codemod @storybook/addon-storyshots-puppeteer @storybook/test-runner @everything-registry/sub-chunk-875 eslint-plugin-storybook @junk-temporary-prototypes/preview-api @junk-temporary-prototypes/source-loader @junk-temporary-prototypes/core-server @junk-temporary-prototypes/csf-tools @junk-temporary-prototypes/manager-api @junk-temporary-prototypes/blocks @junk-temporary-prototypes/codemod @junk-temporary-prototypes/components @junk-temporary-prototypes/addon-links @junk-temporary-prototypes/addon-storyshots-puppeteer @leafygreen-ui/lib @muraldevkit/ds-manifest-builder @nativescript/storybook @pixi/storybook-renderer playwright-ct-storybook @vibrant-ui/core @vibrant-ui/forms @vibrant-ui/components-web @animaapp/storybook-components @workday/canvas-kit-docs @zalastax/nolb-_stor @storybook-vue/components @storybook-vue/blocks @storybook/csf-tools @storybook/manager-api @storybook/core-server @storybook/playwright-ct @storybook/nextjs-server @storybook/blocks @storybook/preview-api @storybook/react-native @storybook/testing-react @storybook/server @vitro/codemod @types/storybook__addon-info @squaredup/test-runner @alibaba-aero/storybook-addon-docs @zeplin/cli-connect-storybook-plugin @dblechoc/storybook-addon-docs @deptdk/liquidjs-renderer test-runner-with-snap-speed-exp test-runner-with-snap-speed-exp2 raf-storybook-addon-docs-test chromatic-cypress chromatic-playwright @chromatic-com/cypress @chromatic-com/playwright @chromaui/archive-storybook @component-controls/core creevey storybook-framework-template-engine storybook-vue-addon @divriots/csf-helpers @divriots/csf-react-renderer @divriots/csf-simple-book

0.1.5--canary.82.2c2dd28.0

8 days ago

0.1.5--canary.82.5938682.0

8 days ago

8 days ago

8 days ago

0.1.4--canary.83.ab72fee.0

8 days ago

0.1.4--canary.82.1657476.0

9 days ago

0.1.4--canary.82.4a5a941.0

9 days ago

0.1.4--canary.82.004ec21.0

9 days ago

0.1.4--canary.82.beb2113.0

9 days ago

0.1.4--canary.82.5e73744.0

9 days ago

0.1.4--canary.82.934057e.0

9 days ago

0.1.4--canary.82.eb42c88.0

9 days ago

0.1.4--canary.82.c8a52dd.0

9 days ago

0.1.4--canary.82.07bccd8.0

9 days ago

0.1.4--canary.82.f4adda6.0

9 days ago

0.1.4--canary.82.2a09ac2.0

9 days ago

0.1.4--canary.82.941efd8.0

10 days ago

0.1.4--canary.80.ba37fd5.0

15 days ago

0.1.4--canary.80.f469755.0

22 days ago

0.1.4--canary.80.aedde7f.0

25 days ago

0.1.4--canary.80.632d12b.0

27 days ago

1 month ago

1 month ago

0.1.3--canary.78.9722e80.0

1 month ago

0.1.2--canary.71.a3cacc5.0

5 months ago

5 months ago

5 months ago

0.1.2--canary.71.b1f85ff.0

5 months ago

0.1.2--canary.71.cad875c.0

5 months ago

11 months ago

11 months ago

1 year ago

0.0.2--canary.65.ef100c4.0

1 year ago

0.1.1--canary.f0d3083.0

1 year ago

1 year ago

1 year ago

0.0.2--canary.62.bf5823f.0

1 year ago

0.0.2--canary.62.4a3b146.0

1 year ago

0.0.2--canary.bdd5424.0

1 year ago

0.0.2--canary.64.1cdb44b.0

1 year ago

1 year ago

0.0.2--canary.62.f5c59be.0

1 year ago

0.0.2--canary.62.1b51cab.0

1 year ago

0.0.2--canary.7705a54.0

1 year ago

0.0.2--canary.62.d7abc02.0

1 year ago

0.0.2--canary.62.5777911.0

1 year ago

0.0.2--canary.62.9cd6451.0

1 year ago

0.0.2--canary.60.011a95e.0

1 year ago

1 year ago

0.0.2--canary.29.e31af55.0

1 year ago

0.0.2--canary.58.7052fb8.0

1 year ago

0.0.2--canary.51.084d9eb.0

1 year ago

0.0.2--canary.49.b089ae5.0

2 years ago

0.0.2--canary.3094f05.0

1 year ago

0.0.2--canary.5b59926.0

1 year ago

0.0.2--canary.49.258942b.0

2 years ago

0.0.2--canary.52.d2acbe4.0

1 year ago

0.0.2--canary.29.77954d8.0

1 year ago

0.0.2--canary.53.4879818.0

1 year ago

0.0.2--canary.55.8133684.0

1 year ago

0.0.2--canary.51.23af5af.0

2 years ago

0.0.2--canary.51.26e6539.0

2 years ago

0.0.2--canary.43.5edcaf6.0

1 year ago

0.0.2--canary.48.3bd2bd7.0

2 years ago

0.0.2--canary.49.9d84710.0

2 years ago

0.0.2--canary.54.75c3237.0

1 year ago

0.0.2--canary.49.65292c2.0

1 year ago

0.0.2--canary.43.a3d8c69.0

2 years ago

0.0.2--canary.36.ecfc79e.0

2 years ago

0.0.2--canary.57.a8fc7a0.0

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

0.0.2--canary.795e486.0

1 year ago

0.0.2--canary.50.794a0bf.0

2 years ago

0.0.2--canary.5f921f0.0

1 year ago

0.0.2--canary.51.768ca23.0

2 years ago

0.0.2--canary.48.47fcdb1.0

1 year ago

0.0.2--canary.fed52be.0

1 year ago

1 year ago

1 year ago

0.0.2--canary.50.45981a0.0

2 years ago

1 year ago

1 year ago

0.0.2--canary.0899bb7.0

2 years ago

0.0.2--canary.92ac0db.0

2 years ago

0.0.2--canary.7c6c115.0

2 years ago

0.0.2--canary.d38f8f1.0

2 years ago

0.0.2--canary.4566f4d.1

2 years ago

0.0.2--canary.4566f4d.0

2 years ago

0.0.2--canary.789b78e.0

2 years ago

0.0.2--canary.507502b.0

2 years ago

0.0.2--canary.835a408.0

2 years ago

0.0.2--canary.87bc651.0

3 years ago

0.0.2--canary.6aca495.0

3 years ago

0.0.2--canary.68887a1.0

3 years ago

0.0.2--canary.062665d.0

3 years ago

0.0.2--canary.b1d5348.0

3 years ago

0.0.2--canary.a925d24.0

3 years ago

0.0.2--canary.5459c65.0

3 years ago

0.0.2--canary.d61cd6c.0

3 years ago

0.0.2--canary.29b0df7.0

3 years ago

0.0.2--canary.c10361d.0

3 years ago

0.0.2--canary.a1972cb.0

3 years ago

0.0.2--canary.cc8c2b0.0

3 years ago

0.0.2--canary.9c0fda0.0

3 years ago

0.0.2--canary.856a16c.0

3 years ago

0.0.2--canary.3b9fb86.0

3 years ago

0.0.2--canary.4d00998.0

3 years ago

4 years ago

4 years ago