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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrade React and related dependencies to v18 #24967

Closed
wants to merge 3 commits into from

Conversation

aryasaatvik
Copy link

@aryasaatvik aryasaatvik commented Nov 24, 2023

Closes #

What I did

I upgraded React and related dependencies to version 18. This fixes incompatibility issue when using the Badge component in a React 18 TypeScript project as children is no longer an implied field.

Type '{ children: number; status: "neutral"; }' is not assignable to type 'IntrinsicAttributes & BadgeProps'.
  Property 'children' does not exist on type 'IntrinsicAttributes & BadgeProps'.ts(2322)

Removal of implicit children in react 18 types

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>

@JReinhold
Copy link
Contributor

Thanks for the PR! Unfortunately upgrading to React 18 is a breaking change, so it is reserved for the next major release of Storybook (8.0). We've already done this on the release-8-0 branch, but the release is still a while out.

In what scenario are you using the Badge component that is causing the type failure?

@JReinhold JReinhold closed this Nov 24, 2023
@aryasaatvik
Copy link
Author

@JReinhold created a PR #24977 with just the change to BadgeProps type. I am trying to use the Badge component in a TypeScript, react 18 storybook addon project

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