Skip to content

Commit

Permalink
Merge pull request #23058 from storybookjs/api-ref-doc-block-controls…
Browse files Browse the repository at this point in the history
…-install-addon

Docs: Clarify APIs of Controls doc block/addon/argTypes
(cherry picked from commit 893b4a8)
  • Loading branch information
jonniebigodes authored and github-actions[bot] committed Jun 14, 2023
1 parent 753fd85 commit 9c8e890
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/api/doc-block-controls.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ The `Controls` block can be used to show a dynamic table of args for a given sto

</div>

<div class="aside">

⚠️ The Controls doc block will only have functioning UI controls if you have also installed and registered [`@storybook/addon-controls`](../essentials/controls.md) (included in [`@storybook/addon-essentials`](../essentials/introduction.md)).

</div>

![Screenshot of Controls block](./doc-block-controls.png)

<!-- prettier-ignore-start -->
Expand Down Expand Up @@ -66,6 +72,12 @@ The example above applied the parameter at the [component](../writing-stories/pa

</details>

<div class="aside">

💡 This API configures Controls blocks used within docs pages. To configure the Controls addon panel, see the [Controls addon docs](../essentials/controls.md). To configure individual controls, you can specify [argTypes](./arg-types.md#control) for each.

</div>

### `exclude`

Type: `string[] | RegExp`
Expand Down

0 comments on commit 9c8e890

Please sign in to comment.