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

Types: Remove DecoratorFn, Story, ComponentStory, ComponentStoryObj, ComponentStoryFn and ComponentMeta types #25477

Merged
merged 3 commits into from
Jan 5, 2024

Conversation

yannbf
Copy link
Member

@yannbf yannbf commented Jan 5, 2024

Closes #25341

What I did

The Story type is now removed in favor of StoryFn and StoryObj.

Additionally, for React, the ComponentStory, ComponentStoryObj, ComponentStoryFn and ComponentMeta types are now removed in favor of StoryFn, StoryObj and Meta.

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 section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

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.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

Copy link
Contributor

github-actions bot commented Jan 5, 2024

Fails
🚫 PR is marked with "BREAKING CHANGE" label.

Generated by 🚫 dangerJS against 4c7e545

@yannbf yannbf force-pushed the yann/remove-deprecated-story-and-meta-types branch from 7119e2b to 871d749 Compare January 5, 2024 17:24
@yannbf yannbf changed the title Types: Remove Story, ComponentStory, ComponentStoryObj, ComponentStoryFn and ComponentMeta types Types: Remove DecoratorFn, Story, ComponentStory, ComponentStoryObj, ComponentStoryFn and ComponentMeta types Jan 5, 2024
@yannbf yannbf merged commit 656adbe into next Jan 5, 2024
58 of 59 checks passed
@yannbf yannbf deleted the yann/remove-deprecated-story-and-meta-types branch January 5, 2024 18:49
@github-actions github-actions bot mentioned this pull request Jan 5, 2024
19 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove Story types in favor of StoryFn
2 participants