[LG-2957] feat: GuideCue - Update Button Focus #3277
+80
−26
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
🦋 Changeset detectedLatest commit: 8ae34c5 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
Size Change: +85 B (+0.01%) Total Size: 1.62 MB
ℹ️ View Unchanged
|
|
Coverage after merging ar/LG-2957-close-button into main will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
adamrasheed
requested review from
a team,
TheSonOfThomp and
Copilot
and removed request for
a team
There was a problem hiding this comment.
Pull Request Overview
This PR updates the GuideCue component to set initial focus on the primary button instead of relying on default focus behavior, improving user experience when the tooltip opens.
- Replaced
useIdAllocatorhook withuseRefto reference the primary button for focus targeting - Refactored style functions to use helper methods instead of inline style composition
- Fixed spelling errors in comments ("multip-step" → "multi-step", "automically" → "automatically", "cloese" → "close")
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| packages/guide-cue/src/GuideCueTooltip/GuideCueTooltip.tsx | Updated focus trap to target primary button using ref instead of ID-based approach; refactored style composition to use helper functions |
| packages/guide-cue/src/GuideCueTooltip/GuideCueTooltip.styles.ts | Created getCloseButtonStyle and getTooltipStyles helper functions; made internal styles private |
| packages/guide-cue/src/GuideCue/GuideCue.tsx | Fixed spelling errors in comments |
| packages/guide-cue/src/GuideCue/GuideCue.spec.tsx | Added tests to verify primary button is focusable for both standalone and multi-step tooltips |
| .changeset/real-lamps-teach.md | Added changeset for patch release |
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.
✍️ Proposed changes
Summary
Updates the
GuideCueTooltipto focus on the primary action button instead of the close button when the tooltip opens, improving keyboard navigation and accessibility.Changes
GuideCueTooltipto usefocus-trap-react'sinitialFocusoption to target the primary buttondocument.getElementByIdfor better React practicesMotivation
Previously, when the GuideCueTooltip opened, focus would automatically go to the first focusable element (the close button). This created a suboptimal user experience as users typically want to proceed with the primary action. By focusing the primary button first, we provide better keyboard navigation and align with common UX patterns where the primary action receives initial focus.
Testing
Technical Details
useRefhook to maintain a reference to the primary buttonfocus-trap-react'sinitialFocusoption as a function that returns the button elementuseIdAllocatorusage since the button no longer needs an ID attribute🎟 Jira ticket: Change order of close button
✅ Checklist
For new components
For bug fixes, new features & breaking changes
pnpm changesetand documented my changes🧪 How to test changes