Viewport addon: Missleading example in README

[no23reason]

Describe the bug
Following the example of setting defaultViewport per story in @storybook/addon-viewport README does not work and breaks the viewport configuration.

To Reproduce
Steps to reproduce the behavior:

1. Create a custom viewport configuration:

import { configure, addParameters } from '@storybook/react';
import { INITIAL_VIEWPORTS } from '@storybook/addon-viewport';

const myViewports = {
    myOne: {
        name: 'MyOne',
        styles: {
            width: '1200px',
            height: '900px'
        }
    }
};

addParameters({
    viewport: {
        viewports: {
            ...INITIAL_VIEWPORTS,
            ...myViewports
        }
    }
});

const req = require.context('../stories', true, /\.tsx?$/);

function loadStories() {
    req.keys().forEach(filename => req(filename));
}

configure(loadStories, module);

2. Create a story and try to set its default viewport following the example.

addStories('Stories', module)
    .add('story', () => </>, { viewport: 'myOne' });

3. The viewport list does not contain MyOne and the default viewport is not set.

Expected behavior
The viewport list contains MyOne and it is set as a default viewport.

System:

• OS: MacOS
• Device: Macbook Pro 2018
• Browser: Chrome, Safari
• Framework: react
• Addons: viewport
• Version: 5.0.0

[shilman]

@tmeasday Didn't #5829 try to address this?

[tmeasday]

You can set viewport: { defaultViewport: 'myOne' }, but cannot set the parameters object to a string (as this breaks auto-merging of parameters).

Did I not end up documenting this properly?

[tmeasday]

Hmm I see I made a typo, I'll fix it.

[tmeasday]

https://github.com/storybooks/storybook/pull/5977/files

[stale]

Hi everyone! Seems like there hasn't been much going on in this issue lately. If there are still questions, comments, or bugs, please feel free to continue the discussion. Unfortunately, we don't have time to get to every issue. We are always open to contributions so please send us a pull request if you would like to help. Inactive issues will be closed after 30 days. Thanks!