Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(material/dialog): focus restoration not working inside shadow dom #21811

Merged
merged 1 commit into from
Mar 5, 2021

Conversation

crisbeto
Copy link
Member

@crisbeto crisbeto commented Feb 4, 2021

Related to #21796. The dialog focus restoration works by grabbing document.activeElement before the dialog is opened and restoring focus to the element on destroy. This won't work if the element is inside the shadow DOM, because the browser will return the shadow root. These changes add a workaround.

Related to angular#21796. The dialog focus restoration works by grabbing
`document.activeElement` before the dialog is opened and restoring focus to
the element on destroy.  This won't work if the element is inside the shadow DOM,
because the browser will return the shadow root. These changes add a workaround.
@crisbeto crisbeto added P3 An issue that is relevant to core functions, but does not impede progress. Important, but not urgent target: patch This PR is targeted for the next patch release labels Feb 4, 2021
@google-cla google-cla bot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Feb 4, 2021
// If the `activeElement` is inside a shadow root, `document.activeElement` will
// point to the shadow root so we have to descend into it ourselves.
const activeElement = this._document.activeElement;
return activeElement?.shadowRoot?.activeElement as HTMLElement || activeElement;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't it possible for the element to be within multiple layers of shadow dom?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is possible, but my assumption was activeElement would point to the closest shadow root. That being said, I haven't actually tried it. If that's the case, we might need some reusable utility under cdk/platform since we have a lot of places that look only at document.activeElement.

Copy link
Member

@jelbourn jelbourn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM as a solution for now, then; we can revisit the shadow dom hierarchy if it becomes a problem

@jelbourn jelbourn added the action: merge The PR is ready for merge by the caretaker label Feb 8, 2021
@annieyw annieyw merged commit be508da into angular:master Mar 5, 2021
annieyw pushed a commit that referenced this pull request Mar 5, 2021
…#21811)

Related to #21796. The dialog focus restoration works by grabbing
`document.activeElement` before the dialog is opened and restoring focus to
the element on destroy.  This won't work if the element is inside the shadow DOM,
because the browser will return the shadow root. These changes add a workaround.

(cherry picked from commit be508da)
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Apr 5, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
action: merge The PR is ready for merge by the caretaker cla: yes PR author has agreed to Google's Contributor License Agreement P3 An issue that is relevant to core functions, but does not impede progress. Important, but not urgent target: patch This PR is targeted for the next patch release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants