Skip to content

Guide: Place focus on the guide's container instead of its first tabbable #52300

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.

Sign up for GitHub

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

Merged
noisysocks merged 2 commits into from
Jul 5, 2023
Merged

Guide: Place focus on the guide's container instead of its first tabbable #52300

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
19cc8ec
Guide: Place focus on the guide's container instead of its first tabb…
noisysocks Jul 5, 2023
8a3a6aa
Update CHANGELOG
noisysocks Jul 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/components/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
- `Modal`: Add small top padding to the content so that avoid cutting off the visible outline when hovering items ([#51829](https://github.com/WordPress/gutenberg/pull/51829)).
- `DropdownMenu`: fix icon style when dashicon is used ([#43574](https://github.com/WordPress/gutenberg/pull/43574)).
- `UnitControl`: Fix crash when certain units are used ([#52211](https://github.com/WordPress/gutenberg/pull/52211)).
- `Guide`: Place focus on the guide's container instead of its first tabbable ([#52300](https://github.com/WordPress/gutenberg/pull/52300)).

## 25.2.0 (2023-06-23)

Expand Down
23 changes: 10 additions & 13 deletions packages/components/src/guide/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ import classnames from 'classnames';
import { useState, useEffect, Children, useRef } from '@wordpress/element';
import deprecated from '@wordpress/deprecated';
import { __ } from '@wordpress/i18n';
import { focus } from '@wordpress/dom';

/**
* Internal dependencies
Expand Down Expand Up @@ -59,9 +58,17 @@ function Guide( {
onFinish,
pages = [],
}: GuideProps ) {
const guideContainer = useRef< HTMLDivElement >( null );
const ref = useRef< HTMLDivElement >( null );
const [ currentPage, setCurrentPage ] = useState( 0 );

useEffect( () => {
// Place focus at the top of the guide on mount and when the page changes.
const frame = ref.current?.querySelector( '.components-guide' );
if ( frame instanceof HTMLElement ) {
frame.focus();
}
}, [ currentPage ] );

useEffect( () => {
if ( Children.count( children ) ) {
deprecated( 'Passing children to <Guide>', {
Expand All @@ -71,16 +78,6 @@ function Guide( {
}
}, [ children ] );

useEffect( () => {
// Each time we change the current page, start from the first element of the page.
// This also solves any focus loss that can happen.
if ( guideContainer.current ) {
(
focus.tabbable.find( guideContainer.current ) as HTMLElement[]
)[ 0 ]?.focus();
}
}, [ currentPage ] );

if ( Children.count( children ) ) {
pages =
Children.map( children, ( child ) => ( {
Expand Down Expand Up @@ -124,7 +121,7 @@ function Guide( {
event.preventDefault();
}
} }
ref={ guideContainer }
ref={ ref }
>
<div className="components-guide__container">
<div className="components-guide__page">
Expand Down