-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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
Navigator
: add focus restoration
#38149
Merged
Merged
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
d22645e
`Navigator`: add `focusTargetSelector` to the options
ciampo 257c6dc
Use `focusTargetSelector` to restore focus when navigating back
ciampo 13f4860
Update Storybook example to make use of `focusTargetSelector`
ciampo a84d1da
Update the Preferences Modal to make use of `focusTargetSelector`
ciampo 5ccb775
Update the Global Styles Sidebar to make use of `focusTargetSelector`
ciampo b11fd4f
Update docs
ciampo c741256
Assign fallback back to `push` options to avoid error when destructur…
ciampo be58835
Add focus restoration unit tests
ciampo b5e2c39
Merge wrapper refs
ciampo 2cd1dfe
CHANGELOG
ciampo e398a19
Fix `push` type by marking `options` as optional parameter
ciampo b3e5ede
Simplify stack operations: compute isInitial, use `usePrevious` for `…
ciampo File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,8 +9,13 @@ import { css } from '@emotion/react'; | |
/** | ||
* WordPress dependencies | ||
*/ | ||
import { useContext, useEffect, useState, useMemo } from '@wordpress/element'; | ||
import { useReducedMotion, useFocusOnMount } from '@wordpress/compose'; | ||
import { focus } from '@wordpress/dom'; | ||
import { useContext, useEffect, useMemo, useRef } from '@wordpress/element'; | ||
import { | ||
useReducedMotion, | ||
useMergeRefs, | ||
usePrevious, | ||
} from '@wordpress/compose'; | ||
import { isRTL } from '@wordpress/i18n'; | ||
|
||
/** | ||
|
@@ -47,7 +52,9 @@ function NavigatorScreen( props: Props, forwardedRef: Ref< any > ) { | |
const prefersReducedMotion = useReducedMotion(); | ||
const { location } = useContext( NavigatorContext ); | ||
const isMatch = location.path === path; | ||
const ref = useFocusOnMount(); | ||
const wrapperRef = useRef< HTMLDivElement >( null ); | ||
|
||
const previousLocation = usePrevious( location ); | ||
|
||
const cx = useCx(); | ||
const classes = useMemo( | ||
|
@@ -64,20 +71,53 @@ function NavigatorScreen( props: Props, forwardedRef: Ref< any > ) { | |
[ className ] | ||
); | ||
|
||
// This flag is used to only apply the focus on mount when the actual path changes. | ||
// It avoids the focus to happen on the first render. | ||
const [ hasPathChanged, setHasPathChanged ] = useState( false ); | ||
// Focus restoration | ||
const isInitialLocation = location.isInitial && ! location.isBack; | ||
useEffect( () => { | ||
setHasPathChanged( true ); | ||
}, [ path ] ); | ||
// Only attempt to restore focus: | ||
// - if the current location is not the initial one (to avoid moving focus on page load) | ||
// - when the screen becomes visible | ||
// - if the wrapper ref has been assigned | ||
if ( isInitialLocation || ! isMatch || ! wrapperRef.current ) { | ||
return; | ||
} | ||
|
||
let elementToFocus: HTMLElement | null = null; | ||
|
||
// When navigating back, if a selector is provided, use it to look for the | ||
// target element (assumed to be a node inside the current NavigatorScreen) | ||
if ( location.isBack && previousLocation?.focusTargetSelector ) { | ||
elementToFocus = wrapperRef.current.querySelector( | ||
previousLocation.focusTargetSelector | ||
); | ||
} | ||
|
||
// If the previous query didn't run or find any element to focus, fallback | ||
// to the first tabbable element in the screen (or the screen itself). | ||
if ( ! elementToFocus ) { | ||
const firstTabbable = ( focus.tabbable.find( | ||
wrapperRef.current | ||
) as HTMLElement[] )[ 0 ]; | ||
|
||
elementToFocus = firstTabbable ?? wrapperRef.current; | ||
} | ||
|
||
elementToFocus.focus(); | ||
}, [ isInitialLocation, isMatch ] ); | ||
|
||
const mergedWrapperRef = useMergeRefs( [ forwardedRef, wrapperRef ] ); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Merging the two refs, so that they are correctly assigned to the wrapper element regardless of the value of |
||
|
||
if ( ! isMatch ) { | ||
return null; | ||
} | ||
|
||
if ( prefersReducedMotion ) { | ||
return ( | ||
<View ref={ forwardedRef } className={ classes } { ...otherProps }> | ||
<View | ||
ref={ mergedWrapperRef } | ||
className={ classes } | ||
{ ...otherProps } | ||
> | ||
{ children } | ||
</View> | ||
); | ||
|
@@ -120,7 +160,7 @@ function NavigatorScreen( props: Props, forwardedRef: Ref< any > ) { | |
|
||
return ( | ||
<motion.div | ||
ref={ hasPathChanged ? ref : undefined } | ||
ref={ mergedWrapperRef } | ||
className={ classes } | ||
{ ...otherProps } | ||
{ ...animatedProps } | ||
|
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
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
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
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This code effectively replicates the same logic as in the
useFocusOnMount
's logic