Exciting news!Announcing our $4.6M Series Seed. Learn more
Socket
LoveBlogFAQ
Install
Log in

@kadira/react-storybook-addon-info

Package Overview
Dependencies
3
Maintainers
6
Versions
23
Issues
File Explorer

Advanced tools

@kadira/react-storybook-addon-info

A React Storybook addon to show additional information for your stories.

    3.4.0latest

Version published
Maintainers
6
Yearly downloads
16,564
decreased by-64.83%

Weekly downloads

Readme

Source

React Storybook Info Addon

A React Storybook addon to show additional information for your stories.

React Storybook Screenshot

Usage

Install the following npm module:

npm i -D @kadira/react-storybook-addon-info

Then set the addon in the place you configure storybook like this:

import { configure, setAddon } from '@kadira/storybook'; import infoAddon from '@kadira/react-storybook-addon-info'; setAddon(infoAddon); configure(function () { ... }, module);

Then create your stories with the .addWithInfo API.

import React from 'react'; import Button from './Button'; import { storiesOf, action } from '@kadira/storybook'; storiesOf('Button') .addWithInfo( 'simple usage', ` This is the basic usage with the button with providing a label to show the text. `, () => ( <div> <Button label="The Button" onClick={action('onClick')}/> <br /> <p> Click the "?" mark at top-right to view the info. </p> </div> ), );

Have a look at this example stories to learn more about the addWithInfo API.

The FAQ

Components lose their names on static build

Component names also get minified with other javascript code when building for production. When creating components, set the displayName static property to show the correct component name on static builds.

Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc