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.

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

docs: update outdated guide to make code open by default #26872

Open
wants to merge 1 commit into
base: next
Choose a base branch
from

Conversation

abiriadev
Copy link

What I did

For storybook 7 or higher, the code below does not work.

export const parameters = {
  docs: {
    source: {
      state: 'open',
    },
  },
};

It should be fixed like below:

export const parameters = {
  docs: {
    canvas: {
      sourceState: 'shown'
    }
  }
};

However, this document seems not changed so far. So I updated it.

References:

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This is a document change, no testing is required.

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

For storybook 7 or higher, the code below does not work.

```js
export const parameters = {
  docs: {
    source: {
      state: 'open',
    },
  },
};
```

It should be fixed like below:

```js
export const parameters = {
  docs: {
    canvas: {
      sourceState: 'shown'
    }
  }
};
```

However, this document seems not changed so far. So I updated it.

## References:

- https://storybook.js.org/docs/api/doc-block-canvas#sourcestate
- storybookjs#10430
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants