Skip to content

Table of contents block accessibility improvements #54322

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
alexstine merged 11 commits into from
Sep 27, 2023
Merged

Table of contents block accessibility improvements #54322

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
a791c30
Accessibility improvements for table of contents block.
alexstine Sep 8, 2023
5698a02
Revert save function changes.
alexstine Sep 10, 2023
7d35d5d
Remove unneeded support.
alexstine Sep 10, 2023
c3dc6e3
Merge branch 'trunk' of github.com:WordPress/gutenberg into fix/toc-b…
alexstine Sep 12, 2023
0960e26
Add screen reader description.
alexstine Sep 12, 2023
a78bfe0
Merge branch 'trunk' of github.com:WordPress/gutenberg into fix/toc-b…
alexstine Sep 18, 2023
923e4f2
Merge branch 'trunk' of github.com:WordPress/gutenberg into fix/toc-b…
alexstine Sep 18, 2023
6ba365f
Try using a callback to announce message.
alexstine Sep 18, 2023
c50ec95
Revert blockProps change.
alexstine Sep 18, 2023
b58c158
Disable sub-headings.
alexstine Sep 19, 2023
e732665
Less code for handling onClick callback.
alexstine Sep 24, 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
Next Next commit
Accessibility improvements for table of contents block.
  • Loading branch information
@alexstine
alexstine committed Sep 8, 2023
commit a791c306dbbec7d83001b7027169e63fd32d7aab
2 changes: 1 addition & 1 deletion docs/reference-guides/core-blocks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -851,7 +851,7 @@ Summarize your post with a list of headings. Add HTML anchors to Heading blocks
- **Name:** core/table-of-contents
- **Experimental:** true
- **Category:** layout
- **Supports:** color (background, gradients, link, text), spacing (margin, padding), typography (fontSize, lineHeight), ~~html~~
- **Supports:** ariaLabel, color (background, gradients, link, text), spacing (margin, padding), typography (fontSize, lineHeight), ~~html~~
- **Attributes:** headings, onlyIncludeCurrentPage

## Tag Cloud
Expand Down
3 changes: 2 additions & 1 deletion packages/block-library/src/table-of-contents/block.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@
"__experimentalDefaultControls": {
"fontSize": true
}
}
},
"ariaLabel": true
},
"example": {}
}
7 changes: 5 additions & 2 deletions packages/block-library/src/table-of-contents/edit.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,8 +137,11 @@ export default function TableOfContentsEdit( {
return (
<>
<nav { ...blockProps }>
<ol inert="true">
Copy link
Contributor Author

@alexstine alexstine Sep 8, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure why no one caught this regression. This makes the content completely inaccessible to keyboard users. Please don't do this unless you have a really good reason to.

https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inert

Copy link
Contributor

@joedolson joedolson Sep 8, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

inert was added in several places in d50e613; we maybe should take a look at each usage.

<TableOfContentsList nestedHeadingList={ headingTree } />
<ol>
<TableOfContentsList
nestedHeadingList={ headingTree }
disableLinkActivation={ true }
Copy link
Contributor Author

@alexstine alexstine Sep 8, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Passing this prop to disable link activation for the editor side.

/>
</ol>
</nav>
{ toolbarControls }
Expand Down
18 changes: 17 additions & 1 deletion packages/block-library/src/table-of-contents/list.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,32 @@ const ENTRY_CLASS_NAME = 'wp-block-table-of-contents__entry';

export default function TableOfContentsList( {
nestedHeadingList,
disableLinkActivation,
}: {
nestedHeadingList: NestedHeadingData[];
disableLinkActivation?: boolean;
Copy link
Contributor Author

@alexstine alexstine Sep 8, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a better way to type this?

} ): WPElement {
return (
<>
{ nestedHeadingList.map( ( node, index ) => {
const { content, link } = node.heading;

const entry = link ? (
<a className={ ENTRY_CLASS_NAME } href={ link }>
<a
className={ ENTRY_CLASS_NAME }
href={ link }
aria-disabled={ disableLinkActivation || undefined }
Copy link
Contributor Author

@alexstine alexstine Sep 8, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This communicates disabled state to screen readers.

onClick={
Copy link
Contributor Author

@alexstine alexstine Sep 8, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This prevents click.

disableLinkActivation
? ( event ) => event?.preventDefault()
: undefined
}
onContextMenu={
Copy link
Contributor Author

@alexstine alexstine Sep 8, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This prevents context menu open in new tab/window.

disableLinkActivation
? ( event ) => event?.preventDefault()
: undefined
}
>
{ content }
</a>
) : (
Expand Down
8 changes: 7 additions & 1 deletion packages/block-library/src/table-of-contents/save.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
* WordPress dependencies
*/
import { useBlockProps } from '@wordpress/block-editor';
import { __ } from '@wordpress/i18n';

/**
* Internal dependencies
Expand All @@ -13,8 +14,13 @@ export default function save( { attributes: { headings = [] } } ) {
if ( headings.length === 0 ) {
return null;
}

const blockProps = useBlockProps.save( {
'aria-label': __( 'Table of Contents' ),
} );

return (
<nav { ...useBlockProps.save() }>
<nav { ...blockProps }>
<ol>
<TableOfContentsList
nestedHeadingList={ linearToNestedHeadingList( headings ) }
Expand Down