GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-03-20 05:02:37 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update withKnobs documentation

Browse Source
This commit is contained in:
Michael Shilman 2018-05-28 18:22:14 -07:00
parent 3a4dc2a17d
commit 781804cf1e
1 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
addons/knobs/README.md
View File

@ -319,23 +319,25 @@ const groupId = 'GROUP-ID1';
button(label, handler, groupId);
```
### withKnobs vs withKnobsOptions
### withKnobs options
If you feel like this addon is not performing well enough there is an option to use `withKnobsOptions` instead of `withKnobs`.
withKnobs also accepts two optional options as story parameters.
Usage:
```js
import { storiesOf } from '@storybook/react';
import { withKnobsOptions } from '@storybook/addon-knobs';
import { withKnobs } from '@storybook/addon-knobs';
const stories = storiesOf('Storybook Knobs', module);
stories.addDecorator(withKnobsOptions({
timestamps: true, // Doesn't emit events while user is typing.
escapeHTML: true // Escapes strings to be safe for inserting as innerHTML. This option is true by default in storybook for Vue, Angular, and Polymer, because those frameworks allow rendering plain HTML.
// You can still set it to false, but it's strongly unrecommendend in cases when you host your storybook on some route of your main site or web app.
}));
stories.addDecorator(withKnobs)
stories.add('story name', () => ..., {
knobs: {
timestamps: true, // Doesn't emit events while user is typing.
escapeHTML: true // Escapes strings to be safe for inserting as innerHTML. This option is true by default in storybook for Vue, Angular, and Polymer, because those frameworks allow rendering plain HTML.
// You can still set it to false, but it's strongly unrecommendend in cases when you host your storybook on some route of your main site or web app.
}
});
```
## Typescript