* chore(NA): move elastic-datemath into a ts package * chore(NA): finish elastic-datemath * chore(NA): finish elastic-datemath * chore(NA): source folder for elastic-datemath * chore(NA): add source-maps ace, analytics, apm-config-loader and apm-utils packages * chore(NA): add sourcemaps to packages on typescript * chore(NA): move test fixtures within source * chore(NA): correct exclusions on packages * chore(NA): correct package.json on all packages * chore(NA): correct package.json on all packages * chore(NA): complete kbn pm * chore(NA): default export on elastic-datemath * chore(NA): include logs on kbn-logging * chore(NA): update bundle ref module to last code used in the webpack upstream * chore(NA): update bundle ref module to last code used in the webpack upstream - refactored * chore(NA): remove override method for exportsArgument * fix(NA): typechecking problems by use @internal at javascript import sources on kbn-test package * fix(NA): typescript projects check * fix(NA): run optimizer integration tests from source * chore(NA): fix usage from target for kbn optimizer * chore(NA): path on tsconfig * chore(NA): move tsignore into ts-expect-error * chore(NA): include souce maps on kbn cli dev * chore(NA): include souce maps on kbn-crypto, kbn-server-http-tools and kbn-telemetry-tools * chore(NA): add issue links into the ts-expect-error comments |
||
---|---|---|
.. | ||
lib | ||
index.ts | ||
package.json | ||
preset.js | ||
README.md | ||
tsconfig.json | ||
typings.d.ts | ||
webpack.config.ts |
Kibana Storybook
This package provides ability to add Storybook to any Kibana plugin.
Setup Instructions
-
Add a
.storybook/main.js
configuration file to your plugin. For example, create a file atsrc/plugins/<plugin>/.storybook/main.js
, with the following contents:module.exports = require('@kbn/storybook').defaultConfig;
-
Add your plugin alias to
src/dev/storybook/aliases.ts
config. -
Create sample Storybook stories. For example, in your plugin create a file at
src/plugins/<plugin>/public/components/hello_world/hello_world.stories.tsx
with the following Component Story Format contents:import { MyComponent } from './my_component'; export default { component: MyComponent, title: 'Path/In/Side/Navigation/ToComponent', }; export function Example() { return <MyComponent />; }
-
Launch Storybook with
yarn storybook <plugin>
, or build a static site withyarn storybook --site <plugin>
.
Customizing configuration
The defaultConfig
object provided by the @kbn/storybook package should be all you need to get running, but you can
override this in your .storybook/main.js. Using Storybook's configuration options.