@storybook/addon-actions
- Version 6.4.22
- Published
- 133 kB
- 18 dependencies
- MIT license
Install
npm i @storybook/addon-actions
yarn add @storybook/addon-actions
pnpm add @storybook/addon-actions
Overview
Get UI feedback when an action is performed on an interactive element
Index
Variables
Functions
function action
action: (name: string, options?: ActionOptions) => HandlerFunction;
function configureActions
configureActions: (options?: ActionOptions) => void;
function decorate
decorate: ( _decorators: DecoratorFunction[]) => () => { action: () => void; actions: () => void; withActions: () => void };
function decorateAction
decorateAction: (_decorators: DecoratorFunction[]) => () => void;
function withActions
withActions: (...args: any) => any;
Interfaces
interface ActionDisplay
interface ActionDisplay {}
interface ActionsFunction
interface ActionsFunction {}
call signature
<T extends string>( handlerMap: Record<T, string>, options?: ActionOptions): ActionsMap<T>;
call signature
<T extends string>(...handlers: T[]): ActionsMap<T>;
call signature
<T extends string>( handler1: T, handler2: T, handler3: T, handler4: T, handler5: T, handler6: T, handler7: T, handler8: T, handler9: T, options?: ActionOptions): ActionsMap<T>;
call signature
<T extends string>( handler1: T, handler2: T, handler3: T, handler4: T, handler5: T, handler6: T, handler7: T, handler8: T, handler9: T, handler10: T, options?: ActionOptions): ActionsMap<T>;
call signature
<T extends string>(handler1: T, options?: ActionOptions): ActionsMap<T>;
call signature
<T extends string>( handler1: T, handler2: T, options?: ActionOptions): ActionsMap<T>;
call signature
<T extends string>( handler1: T, handler2: T, handler3: T, options?: ActionOptions): ActionsMap<T>;
call signature
<T extends string>( handler1: T, handler2: T, handler3: T, handler4: T, options?: ActionOptions): ActionsMap<T>;
call signature
<T extends string>( handler1: T, handler2: T, handler3: T, handler4: T, handler5: T, options?: ActionOptions): ActionsMap<T>;
call signature
<T extends string>( handler1: T, handler2: T, handler3: T, handler4: T, handler5: T, handler6: T, options?: ActionOptions): ActionsMap<T>;
call signature
<T extends string>( handler1: T, handler2: T, handler3: T, handler4: T, handler5: T, handler6: T, handler7: T, options?: ActionOptions): ActionsMap<T>;
call signature
<T extends string>( handler1: T, handler2: T, handler3: T, handler4: T, handler5: T, handler6: T, handler7: T, handler8: T, options?: ActionOptions): ActionsMap<T>;
Type Aliases
type ActionOptions
type ActionOptions = Partial<Options> & Partial<TelejsonOptions>;
type ActionsMap
type ActionsMap<T extends string = string> = Record<T, HandlerFunction>;
type DecoratorFunction
type DecoratorFunction = (args: any[]) => any[];
type HandlerFunction
type HandlerFunction = (...args: any[]) => void;
Package Files (13)
- dist/ts3.9/constants.d.ts
- dist/ts3.9/index.d.ts
- dist/ts3.9/models/ActionDisplay.d.ts
- dist/ts3.9/models/ActionOptions.d.ts
- dist/ts3.9/models/ActionsFunction.d.ts
- dist/ts3.9/models/ActionsMap.d.ts
- dist/ts3.9/models/DecoratorFunction.d.ts
- dist/ts3.9/models/HandlerFunction.d.ts
- dist/ts3.9/preview/action.d.ts
- dist/ts3.9/preview/actions.d.ts
- dist/ts3.9/preview/configureActions.d.ts
- dist/ts3.9/preview/decorateAction.d.ts
- dist/ts3.9/preview/withActions.d.ts
Dependencies (18)
Dev Dependencies (2)
Peer Dependencies (2)
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-actions
.
- Markdown[](https://www.jsdocs.io/package/@storybook/addon-actions)
- HTML<a href="https://www.jsdocs.io/package/@storybook/addon-actions"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 3652 ms. - Missing or incorrect documentation? Open an issue for this package.