GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-04-05 16:11:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1406 from storybooks/addon-knobs-readme

Browse Source 
Updated addon knob readme.
This commit is contained in:
Norbert de Langen 2017-07-04 22:50:26 +02:00 committed by GitHub
commit c14bf092f3
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
addons/knobs/README.md
View File

@ -229,6 +229,17 @@ const defaultValue = new Date('Jan 20 2017');
const value = date(label, defaultValue);
```
### withKnobs vs withKnobsOptions
If you feel like this addon is not performing well enough there is an option to use `withKnobsOptions` instead of `withKnobs`.
Usage:
```
story.addDecorator(withKnobsOptions({
debounce: { wait: number, leading: boolean}, // Same as lodash debounce.
timestamps: true // Doesn't emit events while user is typing.
}));
```
## Typescript
If you are using typescript, make sure you have the type definitions installed for the following libs: