@storybook/addon-controls
- Version 8.6.12
- Published
- 268 kB
- 3 dependencies
- MIT license
Install
npm i @storybook/addon-controls
yarn add @storybook/addon-controls
pnpm add @storybook/addon-controls
Overview
Interact with component inputs dynamically in the Storybook UI
Index
Variables
variable PARAM_KEY
const PARAM_KEY: string;
Functions
function _default
_default: () => core_dist_types.ProjectAnnotations<core_dist_types.Renderer>;
Interfaces
interface ControlsParameters
interface ControlsParameters {}
property controls
controls: { /** Remove the addon panel and disable the addon's behavior */ disable?: boolean; /** Disable the ability to create or edit stories from the Controls panel */ disableSaveFromUI?: boolean; /** Exclude specific properties from the Controls panel */ exclude?: string[] | RegExp; /** * Show the full documentation for each property in the Controls addon panel, including the * description and default value. */ expanded?: boolean; /** Exclude only specific properties in the Controls panel */ include?: string[] | RegExp; /** * Preset color swatches for the color picker control * * @example PresetColors: [{ color: '#ff4785', title: 'Coral' }, 'rgba(0, 159, 183, 1)', * '#fe4a49'] */ presetColors?: Array< | string | { color: string; title?: string; } >; /** Controls sorting order */ sort?: 'none' | 'alpha' | 'requiredFirst';};
Controls configuration
See Also
https://storybook.js.org/docs/essentials/controls#parameters-1
Package Files (1)
Dependencies (3)
Dev Dependencies (4)
Peer Dependencies (1)
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@storybook/addon-controls
.
- Markdown[](https://www.jsdocs.io/package/@storybook/addon-controls)
- HTML<a href="https://www.jsdocs.io/package/@storybook/addon-controls"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 1030 ms. - Missing or incorrect documentation? Open an issue for this package.