Actions
Watch a video tutorial
The actions addon is used to display data received by event handler (callback) arguments in your stories.
Action args
Actions work via supplying special Storybook-generated βactionβ arguments (referred to as "args" for short) to your stories. There are two ways to get an action arg:
Via @storybook/test fn spy function
The recommended way to write actions is to use the fn
utility from @storybook/test
to mock and spy args. This is very useful for writing component tests. You can mock your component's methods by assigning them to the fn()
function:
If your component calls an arg (because of either the user's interaction or the play
function) and that arg is spied on , the event will show up in the action panel:
Automatically matching args
Another option is to use a global parameter to match all argTypes that match a certain pattern. The following configuration automatically creates actions for each on
argType (which you can either specify manually or can be inferred automatically).
This is quite useful when your component has dozens (or hundreds) of methods and you do not want to manually apply the fn
utility for each of those methods. However, this is not the recommended way of writing actions. That's because automatically inferred args are not available as spies in your play function. If you use argTypesRegex
and your stories have play functions, you will need to also define args with the fn
utility to test them in your play function.
If you need more granular control over which argTypes
are matched, you can adjust your stories and include the argTypesRegex
parameter. For example:
If you're generating argTypes with another addon (like docs, which is the common behavior), ensure the actions addon AFTER the other addon. You can do this by listing it later in the addons registration code in .storybook/main.js
. This is default in essentials.
Action event handlers
It is also possible to detect if your component is emitting the correct HTML events using the parameters.actions.handles
parameter.
This will bind a standard HTML event handler to the outermost HTML element rendered by your component and trigger an action when the event is called for a given selector. The format is <eventname> <selector>
. The selector is optional; it defaults to all elements.
API
Parameters
This addon contributes the following parameters to Storybook, under the actions
namespace:
argTypesRegex
Type: string
Create actions for each arg that matches the regex. Please note the significant limitations of this approach, as described above.
disable
Type: boolean
Disable this addon's behavior. If you wish to disable this addon for the entire Storybook, you should do so when registering addon-essentials
. See the essential addon's docs for more information.
This parameter is most useful to allow overriding at more specific levels. For example, if this parameter is set to true
at the project level, it could then be re-enabled by setting it to false
at the meta (component) or story level.
handles
Type: string[]
Binds a standard HTML event handler to the outermost HTML element rendered by your component and triggers an action when the event is called for a given selector. The format is <eventname> <selector>
. The selector is optional; it defaults to all elements.
See the action event handlers section, above, for more information.
Exports
This addon contributes the following exports to Storybook:
action
Type: (name?: string) => void
Allows you to create an action that appears in the actions panel of the Storybook UI when clicked. The action function takes an optional name parameter, which is used to identify the action in the UI.
Advanced / legacy usage
There are also some older ways to use actions as documented in the advanced README.