From ca11103c6fe8a2ce5b763126248e014bc38896f6 Mon Sep 17 00:00:00 2001 From: Norbert de Langen Date: Mon, 11 Sep 2017 22:53:07 +0200 Subject: [PATCH] CORRECT readme for knobs && change comment on deprecating requiring @storybook/addon-knobs directly --- addons/knobs/README.md | 4 ++-- addons/knobs/src/index.js | 5 ++--- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/addons/knobs/README.md b/addons/knobs/README.md index dc5a5420db8d..123dfbe59424 100644 --- a/addons/knobs/README.md +++ b/addons/knobs/README.md @@ -256,9 +256,9 @@ Usage: ```js import { storiesOf } from '@storybook/react'; -const stories = storiesOf('') +const stories = storiesOf('Storybook Knobs', module); -story.addDecorator(withKnobsOptions({ +stories.addDecorator(withKnobsOptions({ debounce: { wait: number, leading: boolean}, // Same as lodash debounce. timestamps: true // Doesn't emit events while user is typing. })); diff --git a/addons/knobs/src/index.js b/addons/knobs/src/index.js index e433dedb97f3..2681f3860fb2 100644 --- a/addons/knobs/src/index.js +++ b/addons/knobs/src/index.js @@ -14,9 +14,8 @@ deprecate( 'Using @storybook/addon-knobs directly is discouraged, please use @storybook/addon-knobs/{{framework}}' ); -// "Higher order component" / wrapper style API -// In 3.3, this will become `withKnobs`, once our decorator API supports it. -// See /~https://github.com/storybooks/storybook/pull/1527 +// generic higher-order component decorator for all platforms - usage is discouraged +// This file Should be removed with 4.0 release function wrapperKnobs(options) { const channel = addons.getChannel(); manager.setChannel(channel);