STCOM-1238 Accordion vs overlay z-index issues. #2240
Merged
Conversation
This file contains 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
…ighest z-index when focus enters them.
zburke
approved these changes
Mar 8, 2024
There was a problem hiding this comment.
Thanks for the detailed technical explanation in the PR description. I'd love to see a bit of that documentation/explanation filter down into comments directly on Accordion.js itself so the next person looking at the code can, in fact, just look at the code, without needing to dig up this PR to understand why we had to do things this way.
lib/Accordion/Accordion.js
Outdated
Comment on lines
125
to
126
| // only update the accordion z-index if it does not contain focus or if it's not | ||
| // already the highest z-index among other accordions. |
|
github-actions bot
pushed a commit
that referenced
this pull request
Mar 8, 2024
* Accordions retain their z-index after being blurred, and assume the highest z-index when focus enters them. * log changes * remove unnecessary addition to z-index * semi * add comments to code
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.
Problem
Accordions with overlay components could have their overlays overlapped by other accordions due to z-index issues.
Approach
What we've previously done...
Accordions content would overlap overlays/dropdowns from previous accordions... (render with reverse z-index order to accordion index)
fixed, but..
Accordions content would overlap overlays/dropdowns from the following accordions...(have the focused accordion assume highest zindex from the set)
fixed, but
Accordions/overlays would go back to being overlapped if focus left the accordion or went to another pane...
In this PR, when focus moves to the accordion, it will find/assume the highest z-index among other accordions. It will retain this same z-index after it is blurred. If an accordion already has the highest z-index among accordions, it will not update its own. The z-indexes do continue to grow, but only for the life of a view... if navigation happens or accordions leave the DOM, all z-indices will be reset upon return.