kibana/packages/kbn-storybook/README.md

Kibana Storybook

This package provides ability to add Storybook to any Kibana plugin.

• Kibana Storybook
  • Setup Instructions
  • Customizing configuration

Setup Instructions

• Add a .storybook/main.js configuration file to your plugin. For example, create a file at src/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 with yarn 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.

You can also add a manager.ts file to customize various aspects of your Storybook. For example, to change the title and link of the Storybook sidebar, you could add:

addons.setConfig({
  theme: create({
    brandTitle: 'My Plugin',
    brandUrl: 'https://github.com/elastic/kibana/tree/main/src/plugins/my_plugin',
  }),
});

Refer to the Storybook documentation for more information.