fix(NGTE-204): Tour hideOverlay should not trap interactions when set true#668
Draft
chris-connelly-cb wants to merge 1 commit into
Draft
Conversation
When `hideOverlay` is true the Tour now behaves as a true non-modal coachmark: the root forwards `pointer-events` so the underlying page stays interactive, `aria-modal` is omitted, scroll is no longer locked, the FocusTrap is skipped, and the step container auto-focuses so keyboard users can still reach it. Also trims stale deps on the scroll-lock effect. Adds tests covering aria-modal/pointer-events routing, mask absence, per-step override of the prop, and the default modal behavior. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Collaborator
🟡 Heimdall Review Status
🟡
|
| Code Owner | Status | Calculation | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ui-systems-eng-team |
🟡
0/1
|
Denominator calculation
|
chris-connelly-cb
had a problem deploying
to
production
GitHub Actions
Failure
| @@ -345,17 +349,54 @@ const TourComponent = <TourStepId extends string = string>(_props: TourProps<Tou | |||
| ], | |||
Contributor
There was a problem hiding this comment.
First of all, thanks for making this pr!
Maybe it would be better to introduce a separate prop that enables/disables interaction with the background, because hideOverlay was purely a visual preference until this point.
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
3 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.
When
hideOverlayis true the Tour now behaves as a true non-modal coachmark: the root forwardspointer-eventsso the underlying page stays interactive,aria-modalis omitted, scroll is no longer locked, the FocusTrap is skipped, and the step container auto-focuses so keyboard users can still reach it. Also trims stale deps on the scroll-lock effect.Adds tests covering aria-modal/pointer-events routing, mask absence, per-step override of the prop, and the default modal behavior.
What changed? Why?
Root cause (required for bugfixes)
UI changes
Testing
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