@mcdevsl/superset-ui
Version:
54 lines (36 loc) • 1.9 kB
Markdown
## @superset-ui/demo
[](https://david-dm.org/apache-superset/superset-ui-plugins?path=packages/superset-ui-demo)
Storybook of `@superset-ui-plugins` packages. See it live at
[apache-superset.github.io/superset-ui-plugins](https://apache-superset.github.io/superset-ui-plugins)
### Development
#### Run storybook
To view the storybook locally, you should:
1. Clone [superset-ui-plugins](https://github.com/apache-superset/superset-ui-plugins) repo.
2. Run `yarn install && yarn build` in the `superset-ui-plugins` root directory.
3. Change to the demo directory `cd packages/superset-ui-plugins-demo`.
4. 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:
1. Add any new package dependencies via `yarn add <package>`, but if it is `@superset-ui/*`
packages, manually add it to `peerDependencies`.
2. Create a new folder that mirrors the package name
> e.g., `mkdir storybook/stories/superset-ui-color/`
3. Add an `index.js` file to that folder with a default export with the following shape:
> you can use the `|` separator within the `storyPath` string to denote _nested_ stories e.g.,
> `storyPath: '@superset-ui/package|Nested i|Nested ii'`
```javascript
default export {
examples: [
{
storyPath: <string>,
storyName: <string>,
renderStory: <func> () => node,
},
...
]
};
```