argtypes/table

8 notes, read out of this brain and free to use. Each one was extracted from a source and is re-checked against its exam.

table property structure

The table property is an object with properties: category (string), defaultValue ({ detail?: string; summary: string }), disable (boolean), readonly (boolean), subcategory (string), and type ({ detail?: string; summary: string }). It specifies how the arg is documented in ArgTypes doc block, Controls doc block, and Controls panel.

table.category property

The category property is a string that displays the argType under a category heading with the specified label. It can be inferred automatically in some frameworks.

table.defaultValue property

The defaultValue property is an object with type { detail?: string; summary: string } that documents the default value of the argType. Summary is typically used for the value itself, while detail is used for additional information.

table.disable property

The disable property is a boolean. Set to true to remove the argType's row from the table.

table.readonly property

The readonly property is a boolean. Set to true to indicate that the argType is read-only.

table.subcategory property

The subcategory property is a string that displays the argType under a subcategory heading, which displays under the category heading, with the label specified by subcategory.

table.type property

The type property is an object with type { detail?: string; summary: string } that documents the type of the argType. Summary is typically used for the type itself, while detail is used for additional information. It is inferred from the type property. If you need to specify the actual semantic type, use the type property instead.

docs.toc parameter options table

The docs.toc parameter accepts either true (to enable with defaults) or an object with the following properties: | Property | Type | Default | Description | |----------|------|---------|-------------| | contentsSelector | string | '.sbdocs-content' | CSS selector for the container to search for headings. Use this if you have a custom docs page layout. | | disable | boolean | false | When true, it hides the table of contents for the documentation page. A hidden (empty) container is still rendered to preserve the page layout. | | headingSelector | string | 'h3' | CSS selector that defines which heading levels to include in the table of contents. For example, use 'h1, h2, h3' to include the top three heading levels. | | ignoreSelector | string | '.docs-story *, .skip-toc' | CSS selector for headings to exclude from the table of contents. By default, headings inside story blocks are excluded. To also exclude a specific heading, add the skip-toc class to it. | | title | string \| null \| ReactElement | 'Table of contents' (visually hidden) | Text or element to display as the title above the table of contents. Set to null to render no title. When a string is provided, it is rendered as a visually hidden <h2> by default; pass a non-empty string to make it visible. | | unsafeTocbotOptions | object | (none) | Provides additional configuration options passed directly to the underlying Tocbot library. These options are not guaranteed to remain available in future versions of Storybook. |

Give your agent this brain