superset/superset-frontend/temporary_superset_ui/superset-ui/docs/storybook.md
2021-11-26 11:44:57 +08:00

930 B

Using Storybook

You can demo your changes by running the storybook demo locally with the following commands:

yarn install
yarn build
cd packages/superset-ui-demo
yarn storybook:run

Alternatively, you can demo your changes by using the following command while in packages/superset-ui-demo:

yarn storybook

Tips

When developing, if you would like to see live changes in Storybook.

Instead of

import { xxx } from '@superset-ui/plugin-chart-horizon';

which will point to the transpiled code.

Do refer to src

import { xxx } from '@superset-ui/plugin-chart-horizon/src'

Then after you are satisfied with all the changes, yarn build the entire project and remove /src from the import statement and check Storybook again. This rarely happens, but the minification sometimes can cause issue and you may see different results ranging from crashing to different behavior.