Skip to content

Add screen reader instructions for navigating child blocks on block selection #39558

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

Open
alexstine wants to merge 6 commits into
base: trunk
Choose a base branch
from
Open

Add screen reader instructions for navigating child blocks on block selection #39558

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
df2319c
Add aria-description to block props explaining to users how to naviga…
alexstine Mar 17, 2022
11ab2ac
Move functionality to hook.
alexstine Mar 28, 2022
35d5283
Fix description logic for new blocks without inner blocks. Remove ann…
alexstine Mar 29, 2022
cd69062
Merge branch 'trunk' of github.com:wordpress/gutenberg into update/co…
alexstine Mar 29, 2022
a2f1a9b
Merge branch 'trunk' of github.com:wordpress/gutenberg into update/co…
alexstine Jun 12, 2022
faa6cf2
Fix Prettier error.
alexstine Jun 12, 2022
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
Prev Previous commit
Next Next commit
Fix description logic for new blocks without inner blocks. Remove ann… 
…ouncement for blocks that do not need it.
  • Loading branch information
@alexstine
alexstine committed Mar 29, 2022
commit 35d528308b1eca72bf5257d0a3fc43d424938d82
40 changes: 28 additions & 12 deletions ...k-editor/src/components/block-list/use-block-props/use-block-screen-reader-description.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,14 @@ import { useSelect } from '@wordpress/data';
import { store as blockEditorStore } from '../../../store';

export function useBlockScreenReaderDescription( clientId ) {
const { hasChildBlocks, blockTitle } = useSelect(
const { hasChildBlocks, blockTitle, canSupportChildBlocks } = useSelect(
( select ) => {
const { getBlockRootClientId, getBlockName, getBlock } = select(
blockEditorStore
);
const {
getBlockRootClientId,
getBlockName,
getBlock,
getBlockListSettings,
} = select( blockEditorStore );
const clientIdToUse = getBlockRootClientId( clientId );
const blockName = getBlockName(
clientIdToUse ? clientIdToUse : clientId
Expand All @@ -25,19 +28,32 @@ export function useBlockScreenReaderDescription( clientId ) {
getBlock( clientIdToUse ? clientIdToUse : clientId )
?.innerBlocks?.length > 0,
blockTitle: blockType?.title,
canSupportChildBlocks: getBlockListSettings(
clientIdToUse ? clientIdToUse : clientId
),
};
},
[ clientId ]
);
let description;
if ( hasChildBlocks ) {
description = sprintf(
// Translators: 1: The block title to lowercase for good sentence structure.
__( 'Child block of %1$s.' ),
blockTitle.toLowerCase()
);
} else {
description = __( 'Testing non-child block description.' );
if ( canSupportChildBlocks ) {
if ( hasChildBlocks ) {
description = sprintf(
// Translators: 1: The block title to lowercase for good sentence structure.
__(
'Press Escape key to navigate child blocks of %1$s.'
),
blockTitle.toLowerCase()
);
} else {
description = sprintf(
// Translators: 1: The block title to lowercase for good sentence structure.
__(
'Press Tab followed by Enter keys to add a child block to %s.'
),
blockTitle.toLowerCase()
);
}
}
return description;
}