Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

addon-viewport: Use the new parameterized way of decorators #3610

Merged
merged 4 commits into from
May 20, 2018
Merged

addon-viewport: Use the new parameterized way of decorators #3610

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
975cd9e
Fix Logger Item component
mshaaban088 May 20, 2018
7291811
Use makeDecorator to create withViewport
mshaaban088 May 20, 2018
b594d6c
Use the parameterized style in viewport examples
mshaaban088 May 20, 2018
3c13771
Update viewport documentation
mshaaban088 May 20, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions addons/viewport/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,19 @@ storiesOf('Decorator with string', module)
</h1>
));

// Single
storiesOf('Parameterized story', module)
.addDecorator(withViewport())
.add(
'iPad',
() => (
<h1>
Do I look good on <b>iPad</b>?
</h1>
),
{ viewport: 'ipad' }
);

storiesOf('Decorator with object', module)
.addDecorator(
withViewport({
Expand Down
42 changes: 25 additions & 17 deletions addons/viewport/src/preview/withViewport.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import addons from '@storybook/addons';
import addons, { makeDecorator } from '@storybook/addons';
import CoreEvents from '@storybook/core-events';
import deprecate from 'util-deprecate';

Expand All @@ -11,36 +11,44 @@ import {
function noop() {}
let handler = noop;

const callHandler = (...args) => handler(...args)

const subscription = () => {
const channel = addons.getChannel();
channel.on(VIEWPORT_CHANGED_EVENT_ID, handler);
return () => channel.removeListener(VIEWPORT_CHANGED_EVENT_ID, handler);
channel.on(VIEWPORT_CHANGED_EVENT_ID, callHandler);
return () => channel.removeListener(VIEWPORT_CHANGED_EVENT_ID, callHandler);
};

const setViewport = options => {
const applyViewportOptions = (options = {}) => {
const channel = addons.getChannel();

handler = options.onViewportChange || noop;
if (options.onViewportChange) {
channel.emit(CoreEvents.REGISTER_SUBSCRIPTION, subscription);
}

channel.emit(SET_STORY_DEFAULT_VIEWPORT_EVENT_ID, options.name || DEFAULT_VIEWPORT);
};

export default function withViewport(nameOrOptions) {
const options = typeof nameOrOptions === 'string' ? { name: nameOrOptions } : nameOrOptions;
const withViewport = makeDecorator({
name: 'withViewport',
parameterName: 'viewport',
wrapper: (getStory, context, { options, parameters }) => {
const storyOptions = parameters || options;
const viewportOptions =
typeof storyOptions === 'string' ? { name: storyOptions } : storyOptions;

if (viewportOptions) {
applyViewportOptions(viewportOptions);
}

return (story, context) => {
const decorated = () => {
setViewport(options);
return story();
};
return getStory(context);
},
});

// Absent context means a direct call, withViewport(viewport)(storyFn)
return context ? decorated() : decorated;
};
}
export default withViewport;

export const Viewport = deprecate(({ children, ...options }) => {
setViewport(options);
applyViewportOptions(options);
return children;
}, `<Viewport> usage is deprecated, use .addDecorator(withViewport(viewport)) instead`);
}, `<Viewport> usage is deprecated, use .addParameters({ viewport }) instead`);
2 changes: 1 addition & 1 deletion examples/official-storybook/stories/Logger.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ const Wrapper = styled('div')({
const Title = styled('h1')({
margin: 0,
});
const Item = () => ({
const Item = styled('div')({
listStyle: 'none',
marginBottom: 10,
});
Expand Down
14 changes: 13 additions & 1 deletion examples/official-storybook/stories/__snapshots__/addon-viewport.stories.storyshot
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ exports[`Storyshots Addons|Viewport.Custom Default (Kindle Fire 2) Overridden vi
</div>
`;

exports[`Storyshots Addons|Viewport.Custom Default (Kindle Fire 2) Overridden via "withViewport" decorator 1`] = `
exports[`Storyshots Addons|Viewport.Custom Default (Kindle Fire 2) Overridden via "withViewport" decorator (deprecated) 1`] = `
<div
class="css-9por5e"
>
Expand All @@ -44,6 +44,18 @@ exports[`Storyshots Addons|Viewport.Custom Default (Kindle Fire 2) Overridden vi
</div>
`;

exports[`Storyshots Addons|Viewport.Custom Default (Kindle Fire 2) Overridden via "withViewport" parameterized decorator 1`] = `
<div
class="css-9por5e"
>
I respect my parents but I should be looking good on
<b>
iPad
</b>
.
</div>
`;

exports[`Storyshots Addons|Viewport.withViewport onViewportChange 1`] = `
<div
class="css-1ruxp1v"
Expand Down
11 changes: 10 additions & 1 deletion examples/official-storybook/stories/addon-viewport.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,16 @@ storiesOf('Addons|Viewport.Custom Default (Kindle Fire 2)', module)
</Panel>
))
.add(
'Overridden via "withViewport" decorator',
'Overridden via "withViewport" parameterized decorator',
() => (
<Panel>
I respect my parents but I should be looking good on <b>iPad</b>.
</Panel>
),
{ viewport: 'ipad' }
)
.add(
'Overridden via "withViewport" decorator (deprecated)',
withViewport('iphone6')(() => (
<Panel>
I respect my parents but I should be looking good on <b>iPhone 6</b>.
Expand Down