4.4 KiB
| id | title |
|---|---|
| addon-gallery | Addon Gallery |
This is a list of available addons for Storybook.
Addons maintained by storybook team.
These addons ship with Storybook by default. You can use them right away.
Actions
With actions, you can inspect events related to your components. This is pretty neat when you are manually testing your components.
Also, you can think of this as a way to document events in your components.
Links
With links you can link stories together. With that, you can build demos and prototypes directly from your UI components.
Knobs
Knobs allow you to edit React props dynamically using the Storybook UI. You can also use Knobs as dynamic variables inside your stories.
Notes
With this addon, you can write notes for each story in your component. This is pretty useful when you are working with a team.
Info
If you are using Storybook as a style guide, then this addon will help you to build a nice-looking style guide with docs, automatic sample source code with a PropType explorer.
Options
The Storybook webapp UI can be customised with this addon. It can be used to change the header, show/hide various UI elements and to enable full-screen mode by default.
Storyshots
Storyshots is a way to automaticly jest-snapshot all your stories. More info here.
Community Addons
You need to install these addons directly from NPM in order to use them.
README
With this addon, you can add docs in markdown format for each story. It very useful because most projects and components already have README.md files. Now it is easy to add them into your Storybook.
Story-router
A decorator that allows you to integrate react-router components in your stories.
Host
A decorator with powerful display options for hosting, sizing and framing your components.
Specs
This is a very special addon where it'll allow you to write test specs directly inside your stories. You can even run these tests inside a CI box.
Chapters
With this addon, you can showcase multiple components (or varying component states) within 1 story. Break your stories down into smaller categories (chapters) and subcategories (sections) for more organizational goodness.
Props Combinations
Given possible values for each prop, renders your component with all combinations of prop values. Useful for finding edge cases or just seeing all component states at once.
Backgrounds
With this addon, you can switch between background colors and background images for your preview components. It is really helpful for styleguides.
Material-UI
Wraps your story into MuiThemeProvider. It allows you to add your custom themes, switch between them, make changes in the visual editor and download as JSON file
i18n tools
With this addon, you can test your storybooks with a different text-direction. It is very useful if you are working on components that have to work both in LTR as well as in RTL languages.
JSX preview
This addon shows a preview of the JSX code for each story. It allows you to configure the display and copy the code with a single click.
Intl
With this addon you will have an additional panel at the bottom which provides you buttons to switch the locale and directly see the result in the preview.