-
-
Notifications
You must be signed in to change notification settings - Fork 9.4k
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
UI: Fix composed storybook TooltipLinkList bug where href isn't passed forward #29175
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 91c2e9d. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 1 targetSent with 💌 from NxCloud. |
Fix composed storybook TooltipLinkList bug where href isn't passed forward (cherry picked from commit 1a50094)
@kasperpeulen thank you! |
https://github.com/storybookjs/storybook/blob/v8.3.2/code/core/src/manager/components/sidebar/RefIndicator.tsx#L226 requires item.href
What I did
Composed storybook sidebar ref list expects
href
to be passed from list item https://github.com/storybookjs/storybook/blob/v8.3.2/code/core/src/manager/components/sidebar/RefIndicator.tsx#L226 , this property was not present on the object getting passed to the onClick function https://github.com/storybookjs/storybook/blob/v8.3.2/code/core/src/components/components/tooltip/TooltipLinkList.tsx#L37. This PR adds thehref
property to the object to preventurl.match
from failing on anundefined
variable in https://github.com/storybookjs/storybook/blob/v8.3.2/code/core/src/manager-api/modules/refs.ts#L144Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
This is difficult to create a manual test for, you'd need to set up a composed storybook locally and inject a metadata.json file with a list of key/value pairs of label/url to other storybooks to cause the TooltipLinkList to generate for the composed storybook. I tested this in the debugger for my existing storybook implementation. I can potentially set up a call to review if necessary (my company is a chromatic client).
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.@shilman I would appreciate a canary release, this bug is impacting our storybook in production.
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>
Greptile Summary
This pull request addresses a bug in the TooltipLinkList component, specifically focusing on the handling of the 'href' property in onClick events.
code/core/src/components/components/tooltip/TooltipLinkList.tsx