Permalink
Switch branches/tags
3407-repro 3972-options-knob-on-next 4848-new-example-format add-navbar add-polymer3-support add-react-error-overlay add-typings addon-api-concept addon-knob-vue-decoratorless addon-readme addon-resources core/remove-basic-config dd/babel-plugin-react-docgen-2 dependabot/npm_and_yarn/docs/gatsby-plugin-sharp-2.0.15 dependabot/npm_and_yarn/react-native-modal-datetime-picker-6.0.0 docs-v2-babel docs-v2-highlights docs-v2-monaco docs-v2 docs-v2.1 docs/add-versions-json docusaurus feature/add-navbar-refactor feature/add-navbar feature/custom-react-scripts fix/husky-deprecation fix/react-scripts-latest-fixture issue-3972-options-knob knobs-objects knobs/v2 master ndelange/hoisting-rn ndelangen/RN-fixattempt1 ndelangen/RN-fixattempt2 ndelangen/RN-fixattempt3 ndelangen/RN-fixattempt4 ndelangen/RN-fixattempt5 ndelangen/config-refactor ndelangen/docs-in-official ndelangen/hoisting-rn-attempt1 ndelangen/new-layoutsystem ndelangen/nicer-official-demo ndelangen/reactnext ndelangen/replace-html-webpack-plugin-v2 ndelangen/replace-html-webpack-plugin ndelangen/revert-tgz-file-dependencies ndelangen/temp2 new-docs next ng-dynamic-template oblador/fix-metro-flags-rn-57 on-device-addons on-device-ui-all-prs patch-1 patch-2 poc/addon-editor poc/liveedit-addon poc/liveedit-in-storysource-old poc/liveedit-in-storysource pr/JalilArfaoui/3909 pr/hipstersmoothie/4704 pr/kkemple/4482 pr/maacky/4856 presets/default-webpack react-native-on-device react-native/use-core-for-server redux-ui refactoring/remove-mantra-ui-overhaul-routing refactoring/remove-mantra-ui-overhaul refactoring/remove-mantra release/3.3 release/3.4 release/4.0 release/4.1-merged release/4.1 repro-instruction-update rn-tab-open shilman/angular-cli-example shilman/remove-withevents shilman/3.2.12-release snyk-fix-1n1s5x snyk-fix-iu4xwt snyk-fix-m3aahq snyk-fix-ncwvxj snyk-fix-pek1pb snyk-fix-q1x0k4 snyk-fix-rum9x7 snyk-fix-wmry50 storysource-with-deps tech/emotion10 tech/overhaul-ui-addon-notes-ts tech/overhaul-ui-store tech/overhaul-ui tech/try-github-workflos tmeasday/add-refs-to-stories tmeasday/check-react-access-3.4 tmeasday/embed-preview-context try-to-fix-master ts-migration/channels
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
167 lines (91 sloc) 7.03 KB
id title
addon-gallery
Addon Gallery

This is a list of available addons for Storybook.

Addons maintained by storybook team.

a11y

With a11y you can test compliance of your stories with web accessibility standards.

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 automatically jest-snapshot all your stories. More info here.

Console

Redirects console output (logs, errors, warnings) into Action Logger Panel. withConsole decorator notifies from what stories logs are coming.

Backgrounds

With this addon, you can switch between background colors and background images for your preview components. It is really helpful for styleguides.

Viewport

Viewport allows your stories to be displayed in different sizes and layouts in Storybook. This helps build responsive components inside of Storybook.

Google Analytics

Support google analytics in Storybook

Storysource

Show story source in the addon panel.

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's 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 use your routing-aware 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.

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.

Versions

This addon lets you navigate different versions of static Storybook builds. As such you can see how a component has changed over time.

Apollo

Wrap your stories with the Apollo client for mocking GraphQL queries/mutations.

Screenshot

Save the screenshot image of your stories. via Puppeteer.

Styles

Add ability to customize styles in the story preview area

Figma

Embed Figma designs in a storybook panel.

State

Manage state inside a story. Update components when this state changes.

State

Manage state inside a story. Update components when this state changes. Wrap the story in a function call to setup state management. The story can modify state properties with the provided store. The addon provides a panel to view and reset state.

story2sketch

Convert stories into Sketch 💎 symbols.

styled components theme

styled components theme selection.

AngularJS

Create stories with AngularJS(1.x) components.

JSS theme

JSS theme selection.

React live edit

Provides live react story editing and preview.