@storybook/csf
Storybook Component Story Format (CSF) utilities
Last updated a year ago by shilman .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @storybook/csf 
SYNC missed versions from official npm registry.

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:

  • 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

Current Tags

  • 0.0.1                                ...           latest (a year ago)
  • 0.0.2-alpha.0                                ...           next (9 months ago)

2 Versions

  • 0.0.2-alpha.0                                ...           9 months ago
  • 0.0.1                                ...           a year ago

Copyright 2014 - 2016 © taobao.org |