feat(drawer): add focus management to embedded drawers #3139
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
…ore focusing previously focused element
… for improved focus handling
🦋 Changeset detectedLatest commit: 3192ddf 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 |
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive focus management to embedded drawers, enhancing accessibility and keyboard navigation. When an embedded drawer opens, focus automatically moves to the first focusable element within the drawer, and when closed, focus is restored to the previously focused element.
Key changes:
- Implements focus management logic in
PanelGridcomponent for embedded drawers - Removes redundant focus handling and ARIA attributes from existing components
- Adds interaction stories to test focus behavior for both embedded and overlay drawer modes
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
packages/drawer/src/LayoutComponent/PanelGrid/PanelGrid.tsx |
Adds focus management logic with useIsomorphicLayoutEffect to handle focus transitions |
packages/drawer/src/DrawerToolbarLayout/DrawerToolbarLayout/DrawerToolbarLayoutContent.tsx |
Removes redundant aria-live attributes that are now handled elsewhere |
packages/drawer/src/DrawerToolbarLayout/DrawerToolbarLayout/DrawerToolbarLayout.interactions.stories.tsx |
Adds comprehensive interaction stories to test focus management behavior |
packages/drawer/src/Drawer/Drawer.tsx |
Removes old focus handling logic and adds VisuallyHidden live region for screen reader announcements |
.changeset/beige-lights-kick.md |
Documents the changes for release notes |
Comment on lines
+4
to
11
| import { useIsomorphicLayoutEffect } from '@leafygreen-ui/hooks'; | ||
|
|
||
| import { useDrawerLayoutContext } from '../../DrawerLayout'; | ||
|
|
||
| import { getPanelGridStyles } from './PanelGrid.styles'; | ||
| import { PanelGridProps } from './PanelGrid.types'; | ||
| import { useForwardedRef } from '@leafygreen-ui/hooks'; | ||
|
|
There was a problem hiding this comment.
Import statements should be grouped and ordered consistently. The useForwardedRef import on line 10 should be combined with the other hooks import on line 4.
Suggested change
| import { useIsomorphicLayoutEffect } from '@leafygreen-ui/hooks'; | |
| import { useDrawerLayoutContext } from '../../DrawerLayout'; | |
| import { getPanelGridStyles } from './PanelGrid.styles'; | |
| import { PanelGridProps } from './PanelGrid.types'; | |
| import { useForwardedRef } from '@leafygreen-ui/hooks'; | |
| import { useIsomorphicLayoutEffect, useForwardedRef } from '@leafygreen-ui/hooks'; | |
| import { useDrawerLayoutContext } from '../../DrawerLayout'; | |
| import { getPanelGridStyles } from './PanelGrid.styles'; | |
| import { PanelGridProps } from './PanelGrid.types'; |
Copilot uses AI. Check for mistakes.
Comment on lines
+51
to
+53
| const firstFocusable = layoutRef.current?.querySelector( | ||
| 'button, [href], input, select, textarea, [tabindex]:not([tabindex="-1"])', | ||
| ) as HTMLElement; |
There was a problem hiding this comment.
The CSS selector for focusable elements should be extracted to a constant or utility function to avoid duplication and improve maintainability. This same selector appears to be used elsewhere in the codebase.
Copilot uses AI. Check for mistakes.
Comment on lines
+60
to
+65
| if (document.contains(previouslyFocusedRef.current)) { | ||
| previouslyFocusedRef.current.focus(); | ||
| } else { | ||
| // If the previously focused element is no longer in the DOM, focus the body | ||
| document.body.focus(); | ||
| } |
There was a problem hiding this comment.
Focusing document.body may not provide the best user experience for keyboard navigation. Consider focusing a more appropriate fallback element or using a focus management library that can find the next logical focus target.
Copilot uses AI. Check for mistakes.
|
Size Change: +311 B (+0.02%) Total Size: 1.55 MB
ℹ️ View Unchanged
|
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
This PR enhances the drawer component by adding comprehensive focus management for embedded drawers. The changes ensure that when an embedded drawer is opened, focus automatically moves to the first focusable element within the drawer, and when closed, focus is restored to the previously focused element (typically the trigger button). This improves keyboard navigation and accessibility compliance.
The implementation also fixes a bug that prevented the toolbar from being focused when the drawer is opened, and adds a live region for screen reader announcements when the drawer state changes.
🎟️ Jira ticket: No Jira ticket found
✅ Checklist
pnpm changesetand documented my changes🧪 How to test changes
Test embedded drawer focus management:
Test overlay drawer behavior:
Test accessibility with screen readers:
Run the new interaction stories:
EmbeddedToolbarIsFocusedOnCloseandEmbeddedButtonIsFocusedOnCloseOverlayToolbarIsFocusedOnCloseandOverlayButtonIsFocusedOnClose