Story Selector Addon
The Storybook selector addon can be used to select and share config between stories in Storybook.
Framework Support same as backgrounds addon
Installation
yarn add --dev storybook-addon-selector
or
npm i -D storybook-addon-selector
Configuration
Then create a file called main.js
in your storybook config.
Add following content to it:
moduleexports = addons: 'storybook-addon-selector/register';
Usage
Then write your stories like this:
; title: 'Button' parameters: selector: name: 'unique-name1' icon: 'globe' title: 'title' options: value: 'value1' title: 'option1' default: true value: 'value2' title: 'option2' name: 'unique-name2' icon: 'icon-name' title: 'title' options: value: 'value1' title: 'option1' default: true value: 'value2' title: 'option2' ; const defaultView = <button>Click me</button>;
Then you can listen to addon channel for selected option
addons;addons;addons;
You can add the selectors to all stories with addParameters
in .storybook/preview.js
:
; // <- or your storybook framework ;
If you want to override selectors for a single story or group of stories, pass the selector
parameter:
; title: 'Button'; const defaultView = <button>Click me</button>;defaultViewstory = parameters: selector: name: 'unique-name' icon: 'globe' title: 'title' options: value: 'value1' title: 'option1' default: true value: 'value2' title: 'option2' ;
If you don't want to use selectors for a story, you can set the selector
parameter to []
to skip the addon:
; title: 'Button'; const noSelectors = <button>Click me</button>;noSelectorsstory = parameters: selector: ;