| title | sidebar | ||||
|---|---|---|---|---|---|
Args |
|
A story is a component with a set of arguments that define how the component should render. “Args” are Storybook’s mechanism for defining those arguments in a single JavaScript object. Args can be used to dynamically change props, slots, styles, inputs, etc. It allows Storybook and its addons to live edit components. You do not need to modify your underlying component code to use args.
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.
The 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 property in the Story component if you are using Svelte CSF with the native templating syntax, or use the args key on a CSF story file:
To define the args of a single story, use the args CSF story key:
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
These args will only apply to the story for which they are attached, although you can reuse them via JavaScript object reuse:
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
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 property in the defineMeta function of a Svelte CSF story file or via the args key on the default CSF export:
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:
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
You can also define args at the global level; they will apply to every component's stories unless you overwrite them. To do so, define the args property in the default export of preview.js|ts:
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
For most uses of global args, [globals](../essentials/toolbars-and-globals.mdx) are a better tool for defining globally-applied settings, such as a theme. Using globals enables users to change the value with the toolbar menu.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.
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
If you find yourself re-using the same args for most of a component's stories, you should consider using [component-level args](#component-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:
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
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:
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
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 size and style arg in the Storybook's URL:
?path=/story/avatar--default&args=style:rounded;size:100
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.
The 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 null and undefined can be set by prefixing with a bang !. For example, args=obj.key:val;arr[0]:one;arr[1]:two;nil:!null will be interpreted as:
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
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 !hex(value), !rgba(value) or !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.
## Setting args from within a storyInteractive components often need to be controlled by their containing component or page to respond to events, modify their state and reflect those changes in the UI. For example, when a user toggles a switch component, the switch should be checked, and the arg shown in Storybook should reflect the change. To enable this, you can use the useArgs API exported by @storybook/preview-api:
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
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.
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}
Note that 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 options array.
Using args in addons
If you are writing an addon that wants to read or update args, use the useArgs hook exported by @storybook/manager-api:
{/* prettier-ignore-start */}
{/* prettier-ignore-end */}