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

Updated addon knob readme.
storybookjs · Jul 4, 2017 · c14bf09 · c14bf09
2 parents 89c5f3b + e0fe774
commit c14bf09
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/addons/knobs/README.md b/addons/knobs/README.md
@@ -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: