When an arg’s value changes, the component re-renders, allowing you to interact with components in Storybook’s UI via addons that affect args.
Learn how and why to write stories in the introduction. For details on how args work, read on.
args object can be defined at the story, component and global level. It is a JSON serializable object composed of string keys with matching valid value types that can be passed into a component for your framework.
To define the args of a single story, use the
args CSF story key:
In the above example, we use the object spread feature of ES 2015.
You can also define args at the component level; they will apply to all the component's stories unless you overwrite them. To do so, use the
args key on the
default CSF export:
You can also define args at the global level; they will apply to every component's stories unless you overwrite them. To do so, export the
args key in your
You can separate the arguments to a story to compose in other stories. Here's how you can combine args for multiple stories of the same component.
💡 If you find yourself re-using the same args for most of a component's stories, you should consider using component-level args.
Args are useful when writing stories for composite components that are assembled from other components. Composite components often pass their arguments unchanged to their child components, and similarly, their stories can be compositions of their child components stories. With args, you can directly compose the arguments:
You can use args in your stories to configure the component's appearance, similar to what you would do in an application. For example, here's how you could use a
footer arg to populate a child component:
You can also override the set of initial args for the active story by adding an
args query parameter to the URL. Typically you would use the Controls addon to handle this. For example, here's how you could set a
style arg in the Storybook's URL:
As a safeguard against XSS attacks, the arg's keys and values provided in the URL are limited to alphanumeric characters, spaces, underscores, and dashes. Any other types will be ignored and removed from the URL, but you can still use them with the Controls addon and within your story.
args param is always a set of
key: value pairs delimited with a semicolon
;. Values will be coerced (cast) to their respective
argTypes (which may have been automatically inferred). Objects and arrays are supported. Special values
undefined can be set by prefixing with a bang
!. For example,
args=obj.key:val;arr:one;arr:two;nil:!null will be interpreted as:
Similarly, special formats are available for dates and colors. Date objects will be encoded as
!date(value) with value represented as an ISO date string. Colors are encoded as
!hsla(value). Note that rgb(a) and hsl(a) should not contain spaces or percentage signs in the URL.
Args specified through the URL will extend and override any default values of args set on the story.
Complex values such as JSX elements cannot be serialized to the manager (e.g., the Controls addon) or synced with the URL. Arg values can be "mapped" from a simple string to a complex type using the
mapping property in
argTypes to work around this limitation. It works in any arg but makes the most sense when used with the
select control type.
mapping does not have to be exhaustive. If the arg value is not a property of
mapping, the value will be used directly. Keys in
mapping always correspond to arg values, not their index in the
Using args in addons
If you are writing an addon that wants to read or update args, use the
useArgs hook exported by
In Storybook 6+, we pass the args as the first argument to the story function. The second argument is the “context”, which includes story parameters, globals, argTypes, and other information.
In Storybook 5 and before we passed the context as the first argument. If you’d like to revert to that functionality set the
parameters.passArgsFirst parameter in