feat: Add <FocusTrap> docs
#258
Open
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
Collaborator
🟡 Heimdall Review Status
🟡
|
| Code Owner | Status | Calculation | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ui-systems-eng-team |
🟡
0/1
|
Denominator calculation
|
maximo-macchi-cb
temporarily deployed
to
production
GitHub Actions
Inactive
maximo-macchi-cb
temporarily deployed
to
production
GitHub Actions
Inactive
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What changed? Why?
This PR adds docs pages for the
<FocusTrap>component. This component is used more as a util component for internal CDS component composition. However, the component is fully functional and can be used by CDS customers. Therefore, a proper documentation page should be added for it.Also, a bug in
<FocusTrap>is fixed where when theincludeTriggerInFocusTrapprop was set totrue, the focus would still shift to inside the<FocusTrap>.Root cause (required for bugfixes)
The root cause of the bug is in the last
useEffectin the component where the initial auto focus logic is. There was no check for theincludeTriggerInFocusTrapprop and the query for focusable elements doesn't include the trigger. This PR's fix updates the query so that the trigger is included in the focusable elements array when the prop istrue.UI changesTesting
How has it been tested?
Testing instructions
Illustrations/Icons Checklist
Required if this PR changes files under
packages/illustrations/**orpackages/icons/**Change management
type=routine
risk=low
impact=sev5
automerge=false