.. | ||
.storybook | ||
storybook | ||
package.json | ||
README.md |
@superset-ui/demo
Storybook of @superset-ui-plugins
packages. See it live at
apache-superset.github.io/superset-ui-plugins
Development
Run storybook
To view the storybook locally, you should:
- Clone superset-ui-plugins repo.
- Run
yarn install && yarn build
in thesuperset-ui-plugins
root directory. - Change to the demo directory
cd packages/superset-ui-plugins-demo
. - Run
yarn run storybook
. This will open up a dev server at http://localhost:9001.
Adding new stories
Existing package
If stories already exist for the package you are adding, simply extend the examples
already
exported for that package in the storybook/stories/<package>/index.js
file.
New package
If you are creating stories for a package that doesn't yet have any stories, follow these steps:
-
Add any new package dependencies via
yarn add <package>
, but if it is@superset-ui/*
packages, manually add it topeerDependencies
. -
Create a new folder that mirrors the package name
e.g.,
mkdir storybook/stories/superset-ui-color/
-
Add an
index.js
file to that folder with a default export with the following shape:
you can use the
|
separator within thestoryPath
string to denote nested stories e.g.,storyPath: '@superset-ui/package|Nested i|Nested ii'
default export {
examples: [
{
storyPath: <string>,
storyName: <string>,
renderStory: <func> () => node,
},
...
]
};