UI: Remove defaultProps
from Link
component
#25619
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #24305
What I did
In the already-closed issue referenced above, only a partial fix was originally applied. This PR completes the entire fix by removing
defaultProps
from theLink
typography component, as reinforced and confirmed by this comment on the issue. To summarize, this PR fixes the dev console warningWarning: Link2: Support for defaultProps will be removed from function components in a future major release. Use JavaScript default parameters instead.
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
This change should be functionally equivalent to its previous state (moving default prop values from the deprecated
defaultProps
object to the functional component's prop arguments).Manual testing
Steps to reproduce the issue and verify the fix:
next
branch, which does not contain this fix.yarn task --task sandbox --start-from install --template nextjs/default-ts
. This will take a few minutes to run. Once this completes, if the Storybook sandbox doesn't open in your browser,cd
intosandbox/nextjs-default-ts
and runyarn storybook
.Stories > renderers > react > decorators > Docs
.Warning: Link2: Support for defaultProps will be removed from function components in a future major release. Use JavaScript default parameters instead.
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal
,ci:merged
orci:daily
GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/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>