Skip to content

Table block: Fix semantic structure for screen readers on back-end #54324

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 3 commits into from
Sep 12, 2023
Merged

Table block: Fix semantic structure for screen readers on back-end #54324

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4366c53
Fix table block edit structure for screen readers.
alexstine Sep 9, 2023
dfa45ae
Fix td props. Fix first cell focus.
alexstine Sep 10, 2023
de87fe4
Move className to td.
alexstine Sep 10, 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
40 changes: 21 additions & 19 deletions packages/block-library/src/table/edit.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -349,7 +349,7 @@ function TableEdit( {
useEffect( () => {
if ( hasTableCreated ) {
tableRef?.current
?.querySelector( 'td[contentEditable="true"]' )
?.querySelector( 'td div[contentEditable="true"]' )
?.focus();
setHasTableCreated( false );
}
Expand Down Expand Up @@ -414,31 +414,33 @@ function TableEdit( {
},
columnIndex
) => (
<RichText
tagName={ CellTag }
Copy link
Contributor Author

@alexstine alexstine Sep 9, 2023

Choose a reason for hiding this comment

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

No need for this anymore. It renders in <div> by default.

<CellTag
key={ columnIndex }
scope={ CellTag === 'th' ? scope : undefined }
colSpan={ colspan }
rowSpan={ rowspan }
className={ classnames(
{
[ `has-text-align-${ align }` ]: align,
},
'wp-block-table__cell-content'
) }
scope={ CellTag === 'th' ? scope : undefined }
colSpan={ colspan }
rowSpan={ rowspan }
value={ content }
onChange={ onChange }
onFocus={ () => {
setSelectedCell( {
sectionName: name,
rowIndex,
columnIndex,
type: 'cell',
} );
} }
aria-label={ cellAriaLabel[ name ] }
placeholder={ placeholder[ name ] }
/>
>
<RichText
Copy link
Contributor Author

@alexstine alexstine Sep 9, 2023

Choose a reason for hiding this comment

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

This will likely break visuals but it works due to the cell itself remaining a table cell. The editable content is now done within the cell. This will also likely cause a slightly different back-end vs. the front-end but it isn't up for debate. It simply does not work when you convert a table cell to an editable field. The entire table loses semantic meaning with screen readers.

Copy link
Member

@ellatrix ellatrix Sep 11, 2023

Choose a reason for hiding this comment

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

Why do we need role=textbox if it breaks things? Isn't contenteditable enough?

Copy link
Contributor Author

@alexstine alexstine Sep 11, 2023

Choose a reason for hiding this comment

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

@ellatrix With my changes, it comes with 2 bonuses.

  1. The table semantics are respected.
  2. The editable areas inside the table cells have better text input semantics.

All in all, a big win.

value={ content }
onChange={ onChange }
onFocus={ () => {
setSelectedCell( {
sectionName: name,
rowIndex,
columnIndex,
type: 'cell',
} );
} }
aria-label={ cellAriaLabel[ name ] }
placeholder={ placeholder[ name ] }
/>
</CellTag>
)
) }
</tr>
Expand Down