JSPM

@storybook/addon-actions

3.4.0-alpha.4
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 7464095
  • Score
    100M100P100Q223751F
  • License MIT

Action Logger addon for storybook

Package Exports

  • @storybook/addon-actions
  • @storybook/addon-actions/dist/containers/ActionLogger
  • @storybook/addon-actions/register
  • @storybook/addon-actions/register.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@storybook/addon-actions) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Storybook Addon Actions

Build Status on CircleCI CodeFactor Known Vulnerabilities BCH compliance codecov Storybook Slack Backers on Open Collective Sponsors on Open Collective


Storybook Addon Actions can be used to display data received by event handlers in Storybook.

This addon works with Storybook for:

Screenshot

Getting Started

Install:

npm i -D @storybook/addon-actions

Then, add following content to .storybook/addons.js

import '@storybook/addon-actions/register';

Import the action function and use it to create actions handlers. When creating action handlers, provide a name to make it easier to identify.

Note: Make sure NOT to use reserved words as function names. issues#29

import { storiesOf } from '@storybook/react';
import { action } from '@storybook/addon-actions';

import Button from './button';

storiesOf('Button', module)
  .add('default view', () => (
    <Button onClick={ action('button-click') }>
      Hello World!
    </Button>
  ))

Action Decorators

If you wish to process action data before sending them over to the logger, you can do it with action decorators.

decorateAction takes an array of decorator functions. Each decorator function is passed an array of arguments, and should return a new arguments array to use. decorateAction returns a function that can be used like action but will log the modified arguments instead of the original arguments.

import { decorateAction } from '@storybook/addon-actions';

import Button from './button';

const firstArgAction = decorateAction([
  args => args.slice(0, 1)
]);

storiesOf('Button', module)
  .add('default view', () => (
    <Button onClick={ firstArgAction('button-click') }>
      Hello World!
    </Button>
  ))