fix: account for shadow-dom in activeElement checks #2697
Merged
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
…e focus separately
This reverts commit 4fbcc0a.
🦋 Changeset detectedLatest commit: a51a77c The changes in this PR will be included in the next version bump. This PR includes changesets to release 77 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
nikparo
commented
Sep 9, 2025
Comment on lines
+40
to
+45
| export function isActiveElement(element: Element | null | undefined): boolean { | ||
| if (!element) return false | ||
| const rootNode = element.getRootNode() as Document | ShadowRoot | ||
|
|
||
| return getActiveElement(rootNode) === element | ||
| } |
Contributor
Author
There was a problem hiding this comment.
I'm unsure if this function should be used in the createScope functions or not. Currently those check both whether the element is active and within the scope root. Is that intentional? It seems to me like that would be fragile e.g. if the component uses some kind of portals or renders something outside the scope root.
Member
There was a problem hiding this comment.
That was my thought as well. So yes, let’s add it to the scope and use the scope everywhere if possible
Contributor
Author
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.
Closes #
📝 Description
activeElementchecks are sometimes done usingdocument.activeElement !== element, which is an issue for apps containing shadow-dom elements such as web-components. This prevents Zag from being used in e.g. default Lit setups (#2681).isActiveElementto@zag-js/dom-queryfor consistent activeElement checks.getActiveElementis tweaked to allow for focusable (tabindex="0") web components that do not contain⛳️ Current behavior (updates)
Focus trap and other utilities / machines do not find the focused elment within a shadow-dom root, resulting in unwanted behaviour.
🚀 New behavior
Focused elements are consistently found.
💣 Is this a breaking change (Yes/No):
No
📝 Additional Information