document preventFocusOnOpen prop in useOpenAndCloseFocus and useOverlay hooks #926
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
13 tasks
There was a problem hiding this comment.
Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.
Tip: Turn on automatic Copilot reviews for this repository to get quick feedback on every pull request. Learn more
ktravers
added a commit
to primer/react
that referenced
this pull request
Feb 6, 2025
Based on hooks docs: * https://primer.style/guides/react/hooks/use-open-and-close-focus Related: * primer/design#926
ktravers
changed the title
ktravers
force-pushed
the
ktravers/document-prevent-focus-on-open
branch
from
b4b121e to
f87dd24
Compare
github-merge-queue bot
pushed a commit
to primer/react
that referenced
this pull request
Feb 8, 2025
* only prevent focus when component is open Otherwise, prevents focus from returning to given returnFocusRef. * fixup callback * add component tests asserting expected behavior * update hook tests * add changeset * add dev story for preventFocusOnOpen * document preventFocusOnOpen prop Based on hooks docs: * https://primer.style/guides/react/hooks/use-open-and-close-focus Related: * primer/design#926
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.
Related: primer/react#5636
This PR documents the
preventFocusOnOpenprop available for use in theuseOpenAndCloseFocusanduseOverlayhooks. This prop was introduced here, and has been available for at least four years.Despite being undocumented, it's used fairly regularly, usually via the Overlay and Autocomplete components.