Core: Support groups and info icon in highlight popover menu #31475
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
5 file(s) reviewed, 3 comment(s)
Edit PR Review Bot Settings | Greptile
|
View your CI Pipeline Execution ↗ for commit 262cf42.
☁️ Nx Cloud last updated this comment at |
a30bde5 to
666cc67
Compare
yannbf
reviewed
May 15, 2025
| document.getElementById(key)?.scrollIntoView({ behavior: 'smooth', block: 'center' }); | ||
| }, 100); | ||
| const { helpUrl, nodes } = results?.[type as RuleType]?.find((r) => r.id === id) || {}; | ||
| const openedWindow = helpUrl && window.open(helpUrl, '_blank', 'noopener,noreferrer'); |
There was a problem hiding this comment.
isn't it bad for a11y if the link opens in a new tab?
There was a problem hiding this comment.
Maybe, I don't know. UX wise at least we have an icon to indicate this behavior. For screenreaders I have no idea whether this is okay or not. Either way I think as a general rule we should always be opening 3rd party links in a new tab.
yannbf
approved these changes
May 15, 2025
Package BenchmarksCommit: The following packages have significant changes to their size or dependencies:
|
| Before | After | Difference | |
|---|---|---|---|
| Dependency count | 103 | 103 | 0 |
| Self size | 34 KB | 34 KB | 0 B |
| Dependency size | 42.77 MB | 42.68 MB | 🎉 -87 KB 🎉 |
| Bundle Size Analyzer | Link | Link |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 #31414
What I did
Split up the a11y popover menu to have a separate "Learn how to resolve this violation" button which links out to the Axe documentation. In order to support this I had to introduce the concept of groups to the menu structure, so it now expects an array of arrays of items rather than an array of items.
A handful of icons have been introduced in order to support the desired UX.
Screen.Recording.2025-05-14.at.15.45.53.mov
Checklist 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!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/src/sandbox-templates.tsMake 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/coreteam 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>Greptile Summary
Enhanced the highlight popover menu functionality by adding support for grouped menu items and info icons, improving accessibility violation descriptions and links in the Storybook UI.
menuGroupsproperty incode/core/src/highlight/types.tsto support nested menu item groupingnormalizeOptionsincode/core/src/highlight/utils.tsto handle both legacy and new highlight formatscode/core/src/highlight/useHighlights.stories.tsxdemonstrating grouped items with info iconscode/core/src/highlight/useHighlights.ts