New
Storybook’s Visual Tests addon enters betaVisual test with Chromatic
Star82,046

Controls

Watch a video tutorial on the Storybook channel

The Controls block can be used to show a dynamic table of args for a given story, as a way to document its interface, and to allow you to change the args for a (separately) rendered story (via the Story or Canvas blocks).

If you’re looking for a static table that shows a component's arg types with no controls, see the ArgTypes block instead.

Screenshot of Controls block

ButtonDocs.mdx
Loading...

The Controls doc block will only have functioning UI controls if you have also installed and registered @storybook/addon-controls (included in @storybook/addon-essentials) and haven't turned off inline stories with the inline configuration option.

Controls

Loading...
Configuring with props and parameters

ℹ️ Like most blocks, the Controls block is configured with props in MDX. Many of those props derive their default value from a corresponding parameter in the block's namespace, parameters.docs.controls.

The following exclude configurations are equivalent:

ButtonDocs.mdx
Loading...

The example above applied the parameter at the component (or meta) level, but it could also be applied at the project or story level.

This API configures Controls blocks used within docs pages. To configure the Controls addon panel, see the Controls addon docs. To configure individual controls, you can specify argTypes for each.

exclude

Type: string[] | RegExp

Default: parameters.docs.controls.exclude

Specifies which controls to exclude from the args table. Any controls whose names match the regex or are part of the array will be left out.

include

Type: string[] | RegExp

Default: parameters.docs.controls.include

Specifies which controls to include in the args table. Any controls whose names don't match the regex or are not part of the array will be left out.

of

Type: Story export or CSF file exports

Specifies which story to get the controls from. If a CSF file exports is provided, it will use the primary (first) story in the file.

sort

Type: 'none' | 'alpha' | 'requiredFirst'

Default: parameters.docs.controls.sort or 'none'

Specifies how the controls are sorted.

  • none: Unsorted, displayed in the same order the controls are processed in
  • alpha: Sorted alphabetically, by the arg type's name
  • requiredFirst: Same as alpha, with any required controls displayed first

Was this page helpful?

Markdown accepted ([link text](url), _italic_, **bold**, etc). Your anonymous feedback will be posted publicly on GitHub.

✍️ Edit on GitHub – PRs welcome!
Storybook
Join the community
6,490 developers and counting
WhyWhy StorybookComponent-driven UI
Open source software
Storybook

Maintained by
Chromatic
Special thanks to Netlify and CircleCI