fix(modal): skip hidden elements when setting focus#1400
Draft
anusha-c18 wants to merge 1 commit into
Draft
Conversation
There was a problem hiding this comment.
Pull request overview
Improves Modal focus management so hidden focusable elements don’t interfere with initial focus and the focus trap, addressing keyboard navigation issues when elements (e.g., the close button) are visually hidden.
Changes:
- Filter focusable elements to only those considered visible when trapping focus on
Tab/Shift+Tab. - Update initial-focus behavior to avoid focusing a hidden close button, falling back to the first visible focusable element.
- Add tests covering focus trapping and initial focus when elements are hidden.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
src/components/Modal/Modal.tsx |
Adds visibility filtering for focusable elements and updates initial focus fallback logic. |
src/components/Modal/Modal.test.tsx |
Adds tests for hidden elements in the focus trap and initial focus behavior when the close button is hidden. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+71
to
+73
| // determines whether an element is visible by checking computed styles | ||
| // fails open: an element is only treated as hiddenwhen getComputedStyle | ||
| // explicitly reports `display:none` or `visibility:hidden` |
Comment on lines
+132
to
+136
| if (isElementVisible(closeButtonRef.current)) { | ||
| closeButtonRef.current.focus(); | ||
| } else { | ||
| (getVisibleFocusableElements()[0] ?? modalRef.current)?.focus(); | ||
| } |
Comment on lines
+296
to
+317
| it("initially focuses the first visible focusable element when the close button is hidden", () => { | ||
| const style = document.createElement("style"); | ||
| style.innerHTML = ".p-modal__close { display: none; }"; | ||
| document.head.appendChild(style); | ||
|
|
||
| const { container } = render( | ||
| <Modal | ||
| title="Test" | ||
| close={jest.fn()} | ||
| buttonRow={<button id="test-cancel">Cancel</button>} | ||
| > | ||
| Bare bones | ||
| </Modal>, | ||
| ); | ||
|
|
||
| const closeButton = container.querySelector("button.p-modal__close"); | ||
| const cancelButton = container.querySelector("button#test-cancel"); | ||
|
|
||
| expect(closeButton).not.toHaveFocus(); | ||
| expect(cancelButton).toHaveFocus(); | ||
| document.head.removeChild(style); | ||
| }); |
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
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.
Done
QA
Pinging @canonical/react-library-maintainers for a review.
Storybook
To see rendered examples of all react-components, run:
QA in your project
from
react-componentsrun:Install the resulting tarball in your project with:
QA steps
Percy steps
Fixes
Fixes: #AC-4874