From 3fdc16d74bffbd70bc1a951eba4e7c321372d0a0 Mon Sep 17 00:00:00 2001 From: jonniebigodes Date: Tue, 13 Jun 2023 23:21:45 +0100 Subject: [PATCH] Merge pull request #23058 from storybookjs/api-ref-doc-block-controls-install-addon Docs: Clarify APIs of Controls doc block/addon/argTypes (cherry picked from commit 893b4a8b0e5e09a1dc9f26a723a5ecfa32a79078) --- docs/api/doc-block-controls.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/api/doc-block-controls.md b/docs/api/doc-block-controls.md index e9824ee7e9d8..133ceed32c1c 100644 --- a/docs/api/doc-block-controls.md +++ b/docs/api/doc-block-controls.md @@ -10,6 +10,12 @@ The `Controls` block can be used to show a dynamic table of args for a given sto +
+ +⚠️ 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)). + +
+ ![Screenshot of Controls block](./doc-block-controls.png) @@ -66,6 +72,12 @@ The example above applied the parameter at the [component](../writing-stories/pa +
+ +💡 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. + +
+ ### `exclude` Type: `string[] | RegExp`