Skip to content
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

Add column count to the column block label #30248

Merged
merged 4 commits into from
Apr 12, 2021
Merged

Add column count to the column block label #30248

merged 4 commits into from
Apr 12, 2021

Conversation

diegohaz
Copy link
Member

Description

Closes #29804

This PR modifies the default label on the column block so it includes the position and the total number of columns in the Columns block.

How has this been tested?

Followed instructions on #29804 using VoiceOver.

ScreenFlow.mp4

@diegohaz diegohaz added [Type] Enhancement A suggestion for improvement. [Focus] Accessibility (a11y) Changes that impact accessibility and need corresponding review (e.g. markup changes). [Block] Columns Affects the Columns Block [a11y] Labelling labels Mar 25, 2021
@diegohaz diegohaz requested a review from ajitbohra as a code owner March 25, 2021 14:27
@diegohaz diegohaz self-assigned this Mar 25, 2021
@diegohaz diegohaz requested a review from annezazu March 25, 2021 14:30
@github-actions
Copy link

github-actions bot commented Mar 25, 2021

Size Change: +5.45 kB (0%)

Total Size: 1.43 MB

Filename Size Change
build/annotations/index.js 3.79 kB +4 B (0%)
build/api-fetch/index.js 3.41 kB -3 B (0%)
build/autop/index.js 2.82 kB +8 B (0%)
build/blob/index.js 665 B +1 B (0%)
build/block-directory/index.js 8.63 kB +4 B (0%)
build/block-editor/index.js 127 kB -13 B (0%)
build/block-editor/style-rtl.css 12.4 kB -13 B (0%)
build/block-editor/style.css 12.4 kB -11 B (0%)
build/block-library/blocks/button/style-rtl.css 503 B -48 B (-9%)
build/block-library/blocks/button/style.css 503 B -48 B (-9%)
build/block-library/blocks/buttons/style-rtl.css 364 B -6 B (-2%)
build/block-library/blocks/buttons/style.css 363 B -7 B (-2%)
build/block-library/blocks/cover/style-rtl.css 1.23 kB -11 B (-1%)
build/block-library/blocks/cover/style.css 1.23 kB -12 B (-1%)
build/block-library/blocks/freeform/editor-rtl.css 2.44 kB -6 B (0%)
build/block-library/blocks/freeform/editor.css 2.44 kB -6 B (0%)
build/block-library/blocks/gallery/style-rtl.css 1.09 kB -14 B (-1%)
build/block-library/blocks/gallery/style.css 1.09 kB -15 B (-1%)
build/block-library/blocks/navigation-link/style-rtl.css 1.07 kB +117 B (+12%) ⚠️
build/block-library/blocks/navigation-link/style.css 1.07 kB +118 B (+12%) ⚠️
build/block-library/blocks/navigation/editor-rtl.css 1.24 kB +110 B (+10%) ⚠️
build/block-library/blocks/navigation/editor.css 1.24 kB +108 B (+10%) ⚠️
build/block-library/blocks/page-list/editor-rtl.css 239 B +69 B (+41%) 🚨
build/block-library/blocks/page-list/editor.css 240 B +70 B (+41%) 🚨
build/block-library/blocks/search/editor-rtl.css 189 B +24 B (+15%) ⚠️
build/block-library/blocks/search/editor.css 189 B +24 B (+15%) ⚠️
build/block-library/blocks/search/style-rtl.css 359 B +17 B (+5%) 🔍
build/block-library/blocks/search/style.css 362 B +18 B (+5%) 🔍
build/block-library/blocks/site-logo/editor-rtl.css 438 B +237 B (+118%) 🆘
build/block-library/blocks/site-logo/editor.css 438 B +237 B (+118%) 🆘
build/block-library/blocks/site-logo/style-rtl.css 150 B +35 B (+30%) 🚨
build/block-library/blocks/site-logo/style.css 150 B +35 B (+30%) 🚨
build/block-library/blocks/spacer/editor-rtl.css 308 B -9 B (-3%)
build/block-library/blocks/spacer/editor.css 308 B -9 B (-3%)
build/block-library/blocks/video/style-rtl.css 173 B -14 B (-7%)
build/block-library/blocks/video/style.css 173 B -14 B (-7%)
build/block-library/editor-rtl.css 9.76 kB +233 B (+2%)
build/block-library/editor.css 9.75 kB +228 B (+2%)
build/block-library/index.js 153 kB +1.43 kB (+1%)
build/block-library/reset-rtl.css 502 B -1 B (0%)
build/block-library/reset.css 503 B -1 B (0%)
build/block-library/style-rtl.css 9.38 kB +135 B (+1%)
build/block-library/style.css 9.38 kB +131 B (+1%)
build/block-serialization-default-parser/index.js 1.87 kB -2 B (0%)
build/blocks/index.js 48.5 kB +101 B (0%)
build/components/index.js 286 kB +2.13 kB (+1%)
build/components/style-rtl.css 16.3 kB +73 B (0%)
build/components/style.css 16.3 kB +73 B (0%)
build/compose/index.js 11.2 kB +1 B (0%)
build/core-data/index.js 17.1 kB +561 B (+3%)
build/customize-widgets/index.js 7.09 kB -188 B (-3%)
build/customize-widgets/style-rtl.css 630 B -46 B (-7%)
build/customize-widgets/style.css 631 B -46 B (-7%)
build/data-controls/index.js 839 B +3 B (0%)
build/data/index.js 8.88 kB -5 B (0%)
build/date/index.js 31.9 kB +5 B (0%)
build/dom/index.js 5.19 kB +103 B (+2%)
build/edit-navigation/index.js 17 kB -326 B (-2%)
build/edit-navigation/style-rtl.css 2.86 kB -4 B (0%)
build/edit-navigation/style.css 2.86 kB -5 B (0%)
build/edit-post/index.js 307 kB +695 B (0%)
build/edit-post/style-rtl.css 6.94 kB -192 B (-3%)
build/edit-post/style.css 6.93 kB -192 B (-3%)
build/edit-site/index.js 28 kB -104 B (0%)
build/edit-site/style-rtl.css 4.61 kB -4 B (0%)
build/edit-site/style.css 4.6 kB -5 B (0%)
build/edit-widgets/index.js 15.7 kB +25 B (0%)
build/edit-widgets/style-rtl.css 2.97 kB -4 B (0%)
build/edit-widgets/style.css 2.98 kB -4 B (0%)
build/editor/index.js 42.4 kB -307 B (-1%)
build/editor/style-rtl.css 3.92 kB -34 B (-1%)
build/editor/style.css 3.92 kB -35 B (-1%)
build/format-library/index.js 6.76 kB +2 B (0%)
build/html-entities/index.js 623 B +1 B (0%)
build/i18n/index.js 4.01 kB -2 B (0%)
build/keyboard-shortcuts/index.js 2.53 kB -1 B (0%)
build/keycodes/index.js 1.96 kB +1 B (0%)
build/media-utils/index.js 5.38 kB +1 B (0%)
build/nux/index.js 3.42 kB -1 B (0%)
build/plugins/index.js 2.95 kB +1 B (0%)
build/primitives/index.js 1.42 kB +1 B (0%)
build/priority-queue/index.js 790 B -1 B (0%)
build/react-i18n/index.js 1.46 kB +1 B (0%)
build/redux-routine/index.js 2.84 kB +1 B (0%)
build/reusable-blocks/index.js 3.79 kB -3 B (0%)
build/rich-text/index.js 13.5 kB +44 B (0%)
build/server-side-render/index.js 2.6 kB +10 B (0%)
build/shortcode/index.js 1.7 kB -2 B (0%)
build/token-list/index.js 1.27 kB -1 B (0%)
build/url/index.js 3.02 kB +1 B (0%)
ℹ️ View Unchanged
Filename Size Change
build/a11y/index.js 1.14 kB 0 B
build/block-directory/style-rtl.css 1 kB 0 B
build/block-directory/style.css 1.01 kB 0 B
build/block-library/blocks/archives/editor-rtl.css 61 B 0 B
build/block-library/blocks/archives/editor.css 60 B 0 B
build/block-library/blocks/audio/editor-rtl.css 58 B 0 B
build/block-library/blocks/audio/editor.css 58 B 0 B
build/block-library/blocks/audio/style-rtl.css 112 B 0 B
build/block-library/blocks/audio/style.css 112 B 0 B
build/block-library/blocks/block/editor-rtl.css 161 B 0 B
build/block-library/blocks/block/editor.css 161 B 0 B
build/block-library/blocks/button/editor-rtl.css 475 B 0 B
build/block-library/blocks/button/editor.css 474 B 0 B
build/block-library/blocks/buttons/editor-rtl.css 315 B 0 B
build/block-library/blocks/buttons/editor.css 315 B 0 B
build/block-library/blocks/calendar/style-rtl.css 208 B 0 B
build/block-library/blocks/calendar/style.css 208 B 0 B
build/block-library/blocks/categories/editor-rtl.css 84 B 0 B
build/block-library/blocks/categories/editor.css 83 B 0 B
build/block-library/blocks/categories/style-rtl.css 79 B 0 B
build/block-library/blocks/categories/style.css 79 B 0 B
build/block-library/blocks/code/style-rtl.css 90 B 0 B
build/block-library/blocks/code/style.css 90 B 0 B
build/block-library/blocks/columns/editor-rtl.css 190 B 0 B
build/block-library/blocks/columns/editor.css 190 B 0 B
build/block-library/blocks/columns/style-rtl.css 436 B 0 B
build/block-library/blocks/columns/style.css 435 B 0 B
build/block-library/blocks/cover/editor-rtl.css 605 B 0 B
build/block-library/blocks/cover/editor.css 605 B 0 B
build/block-library/blocks/embed/editor-rtl.css 486 B 0 B
build/block-library/blocks/embed/editor.css 486 B 0 B
build/block-library/blocks/embed/style-rtl.css 401 B 0 B
build/block-library/blocks/embed/style.css 400 B 0 B
build/block-library/blocks/file/editor-rtl.css 175 B 0 B
build/block-library/blocks/file/editor.css 174 B 0 B
build/block-library/blocks/file/style-rtl.css 248 B 0 B
build/block-library/blocks/file/style.css 248 B 0 B
build/block-library/blocks/gallery/editor-rtl.css 704 B 0 B
build/block-library/blocks/gallery/editor.css 705 B 0 B
build/block-library/blocks/group/editor-rtl.css 160 B 0 B
build/block-library/blocks/group/editor.css 160 B 0 B
build/block-library/blocks/group/style-rtl.css 57 B 0 B
build/block-library/blocks/group/style.css 57 B 0 B
build/block-library/blocks/heading/editor-rtl.css 129 B 0 B
build/block-library/blocks/heading/editor.css 129 B 0 B
build/block-library/blocks/heading/style-rtl.css 76 B 0 B
build/block-library/blocks/heading/style.css 76 B 0 B
build/block-library/blocks/html/editor-rtl.css 281 B 0 B
build/block-library/blocks/html/editor.css 281 B 0 B
build/block-library/blocks/image/editor-rtl.css 717 B 0 B
build/block-library/blocks/image/editor.css 716 B 0 B
build/block-library/blocks/image/style-rtl.css 476 B 0 B
build/block-library/blocks/image/style.css 478 B 0 B
build/block-library/blocks/latest-comments/style-rtl.css 281 B 0 B
build/block-library/blocks/latest-comments/style.css 282 B 0 B
build/block-library/blocks/latest-posts/editor-rtl.css 137 B 0 B
build/block-library/blocks/latest-posts/editor.css 137 B 0 B
build/block-library/blocks/latest-posts/style-rtl.css 523 B 0 B
build/block-library/blocks/latest-posts/style.css 522 B 0 B
build/block-library/blocks/legacy-widget/editor-rtl.css 398 B 0 B
build/block-library/blocks/legacy-widget/editor.css 399 B 0 B
build/block-library/blocks/list/style-rtl.css 63 B 0 B
build/block-library/blocks/list/style.css 63 B 0 B
build/block-library/blocks/media-text/editor-rtl.css 191 B 0 B
build/block-library/blocks/media-text/editor.css 191 B 0 B
build/block-library/blocks/media-text/style-rtl.css 535 B 0 B
build/block-library/blocks/media-text/style.css 532 B 0 B
build/block-library/blocks/more/editor-rtl.css 434 B 0 B
build/block-library/blocks/more/editor.css 434 B 0 B
build/block-library/blocks/navigation-link/editor-rtl.css 597 B 0 B
build/block-library/blocks/navigation-link/editor.css 597 B 0 B
build/block-library/blocks/navigation/style-rtl.css 204 B 0 B
build/block-library/blocks/navigation/style.css 205 B 0 B
build/block-library/blocks/nextpage/editor-rtl.css 395 B 0 B
build/block-library/blocks/nextpage/editor.css 395 B 0 B
build/block-library/blocks/page-list/style-rtl.css 167 B 0 B
build/block-library/blocks/page-list/style.css 167 B 0 B
build/block-library/blocks/paragraph/editor-rtl.css 157 B 0 B
build/block-library/blocks/paragraph/editor.css 157 B 0 B
build/block-library/blocks/paragraph/style-rtl.css 247 B 0 B
build/block-library/blocks/paragraph/style.css 248 B 0 B
build/block-library/blocks/post-author/editor-rtl.css 209 B 0 B
build/block-library/blocks/post-author/editor.css 209 B 0 B
build/block-library/blocks/post-author/style-rtl.css 183 B 0 B
build/block-library/blocks/post-author/style.css 184 B 0 B
build/block-library/blocks/post-comments-form/style-rtl.css 250 B 0 B
build/block-library/blocks/post-comments-form/style.css 250 B 0 B
build/block-library/blocks/post-content/editor-rtl.css 139 B 0 B
build/block-library/blocks/post-content/editor.css 139 B 0 B
build/block-library/blocks/post-excerpt/editor-rtl.css 73 B 0 B
build/block-library/blocks/post-excerpt/editor.css 73 B 0 B
build/block-library/blocks/post-excerpt/style-rtl.css 69 B 0 B
build/block-library/blocks/post-excerpt/style.css 69 B 0 B
build/block-library/blocks/post-featured-image/editor-rtl.css 338 B 0 B
build/block-library/blocks/post-featured-image/editor.css 338 B 0 B
build/block-library/blocks/post-featured-image/style-rtl.css 100 B 0 B
build/block-library/blocks/post-featured-image/style.css 100 B 0 B
build/block-library/blocks/preformatted/style-rtl.css 103 B 0 B
build/block-library/blocks/preformatted/style.css 103 B 0 B
build/block-library/blocks/pullquote/editor-rtl.css 183 B 0 B
build/block-library/blocks/pullquote/editor.css 183 B 0 B
build/block-library/blocks/pullquote/style-rtl.css 318 B 0 B
build/block-library/blocks/pullquote/style.css 318 B 0 B
build/block-library/blocks/query-loop/editor-rtl.css 83 B 0 B
build/block-library/blocks/query-loop/editor.css 82 B 0 B
build/block-library/blocks/query-loop/style-rtl.css 315 B 0 B
build/block-library/blocks/query-loop/style.css 317 B 0 B
build/block-library/blocks/query-pagination-numbers/editor-rtl.css 122 B 0 B
build/block-library/blocks/query-pagination-numbers/editor.css 121 B 0 B
build/block-library/blocks/query-pagination/editor-rtl.css 270 B 0 B
build/block-library/blocks/query-pagination/editor.css 262 B 0 B
build/block-library/blocks/query-pagination/style-rtl.css 168 B 0 B
build/block-library/blocks/query-pagination/style.css 168 B 0 B
build/block-library/blocks/query-title/editor-rtl.css 86 B 0 B
build/block-library/blocks/query-title/editor.css 86 B 0 B
build/block-library/blocks/query/editor-rtl.css 795 B 0 B
build/block-library/blocks/query/editor.css 794 B 0 B
build/block-library/blocks/quote/style-rtl.css 169 B 0 B
build/block-library/blocks/quote/style.css 169 B 0 B
build/block-library/blocks/rss/editor-rtl.css 201 B 0 B
build/block-library/blocks/rss/editor.css 202 B 0 B
build/block-library/blocks/rss/style-rtl.css 290 B 0 B
build/block-library/blocks/rss/style.css 290 B 0 B
build/block-library/blocks/separator/editor-rtl.css 99 B 0 B
build/block-library/blocks/separator/editor.css 99 B 0 B
build/block-library/blocks/separator/style-rtl.css 251 B 0 B
build/block-library/blocks/separator/style.css 251 B 0 B
build/block-library/blocks/shortcode/editor-rtl.css 512 B 0 B
build/block-library/blocks/shortcode/editor.css 512 B 0 B
build/block-library/blocks/social-link/editor-rtl.css 164 B 0 B
build/block-library/blocks/social-link/editor.css 165 B 0 B
build/block-library/blocks/social-links/editor-rtl.css 776 B 0 B
build/block-library/blocks/social-links/editor.css 776 B 0 B
build/block-library/blocks/social-links/style-rtl.css 1.32 kB 0 B
build/block-library/blocks/social-links/style.css 1.33 kB 0 B
build/block-library/blocks/spacer/style-rtl.css 48 B 0 B
build/block-library/blocks/spacer/style.css 48 B 0 B
build/block-library/blocks/table/editor-rtl.css 478 B 0 B
build/block-library/blocks/table/editor.css 478 B 0 B
build/block-library/blocks/table/style-rtl.css 402 B 0 B
build/block-library/blocks/table/style.css 402 B 0 B
build/block-library/blocks/tag-cloud/editor-rtl.css 118 B 0 B
build/block-library/blocks/tag-cloud/editor.css 118 B 0 B
build/block-library/blocks/tag-cloud/style-rtl.css 94 B 0 B
build/block-library/blocks/tag-cloud/style.css 94 B 0 B
build/block-library/blocks/template-part/editor-rtl.css 552 B 0 B
build/block-library/blocks/template-part/editor.css 551 B 0 B
build/block-library/blocks/term-description/editor-rtl.css 90 B 0 B
build/block-library/blocks/term-description/editor.css 90 B 0 B
build/block-library/blocks/text-columns/editor-rtl.css 95 B 0 B
build/block-library/blocks/text-columns/editor.css 95 B 0 B
build/block-library/blocks/text-columns/style-rtl.css 166 B 0 B
build/block-library/blocks/text-columns/style.css 166 B 0 B
build/block-library/blocks/verse/editor-rtl.css 50 B 0 B
build/block-library/blocks/verse/editor.css 50 B 0 B
build/block-library/blocks/verse/style-rtl.css 87 B 0 B
build/block-library/blocks/verse/style.css 87 B 0 B
build/block-library/blocks/video/editor-rtl.css 504 B 0 B
build/block-library/blocks/video/editor.css 503 B 0 B
build/block-library/common-rtl.css 1.31 kB 0 B
build/block-library/common.css 1.31 kB 0 B
build/block-library/theme-rtl.css 692 B 0 B
build/block-library/theme.css 693 B 0 B
build/block-serialization-spec-parser/index.js 3.06 kB 0 B
build/deprecated/index.js 787 B 0 B
build/dom-ready/index.js 576 B 0 B
build/edit-post/classic-rtl.css 454 B 0 B
build/edit-post/classic.css 454 B 0 B
build/element/index.js 4.62 kB 0 B
build/escape-html/index.js 735 B 0 B
build/format-library/style-rtl.css 637 B 0 B
build/format-library/style.css 639 B 0 B
build/hooks/index.js 2.28 kB 0 B
build/is-shallow-equal/index.js 699 B 0 B
build/list-reusable-blocks/index.js 3.19 kB 0 B
build/list-reusable-blocks/style-rtl.css 629 B 0 B
build/list-reusable-blocks/style.css 628 B 0 B
build/notices/index.js 1.86 kB 0 B
build/nux/style-rtl.css 731 B 0 B
build/nux/style.css 727 B 0 B
build/reusable-blocks/style-rtl.css 225 B 0 B
build/reusable-blocks/style.css 225 B 0 B
build/viewport/index.js 1.86 kB 0 B
build/warning/index.js 1.14 kB 0 B
build/wordcount/index.js 1.22 kB 0 B

compressed-size-action

@carolinan
Copy link
Contributor

carolinan commented Mar 26, 2021

I have tested the PR with NVDA in Chrome on Windows 10.
Theme: TT1 Blocks, Twenty Twenty-One

When the columns block (the parent) is selected, it reads the labels for all inner columns:

clickable Block: Columns grouping
Block: Column (1 of 3) grouping Add block menu button collapsed subMenu out of grouping
Block: Column (2 of 3) grouping Add block menu button collapsed subMenu out of grouping
Block: Column (3 of 3) grouping Add block

and so on.
I am not sure if this is on purpose. It might be too noisy? Perhaps only the total number of columns should be announced?

When I navigate between the column blocks the counter is announced correctly.

-In the video, how did you navigate between the inner columns?
I found that the visual focus indicator, the box shadow, does not move between the inner columns when I navigate with the arrow keys. It actually does not move when I navigate away from the columns block and focus should be on the next block so this is a major issue.
I did revert back to the current trunk and confirmed that this is not an issue with this PR but I was wondering why our results are not the same.

Update: I can only reproduce this with NVDA. So maybe it is just about me not being sure how to navigate when the screen reader is active 🙏

@@ -73,6 +76,10 @@ function ColumnEdit( {
: InnerBlocks.ButtonBlockAppender,
} );

const columnsCount = columnsIds.length;
const currentColumnPosition = columnsIds.indexOf( clientId ) + 1;
Copy link
Contributor

Choose a reason for hiding this comment

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

Would getBlockIndex and getBlockOrder work for this? When I tried earlier this week I was not able to solve it.

@alexstine
Copy link
Contributor

Just interested, does anyone think this PR could conflict with what I am trying to do here?

#29060

I believe I have used getBlockCount() there to grab the total. I just wonder if this would create a collision of sorts later down the road.

@diegohaz
Copy link
Member Author

diegohaz commented Apr 8, 2021

Thanks for reviewing this @carolinan!

When the columns block (the parent) is selected, it reads the labels for all inner columns:

clickable Block: Columns grouping
Block: Column (1 of 3) grouping Add block menu button collapsed subMenu out of grouping
Block: Column (2 of 3) grouping Add block menu button collapsed subMenu out of grouping
Block: Column (3 of 3) grouping Add block

and so on.
I am not sure if this is on purpose. It might be too noisy? Perhaps only the total number of columns should be announced?

That's indeed a problem. I believe it's due to the use of the group role.

-In the video, how did you navigate between the inner columns?
I found that the visual focus indicator, the box shadow, does not move between the inner columns when I navigate with the arrow keys. It actually does not move when I navigate away from the columns block and focus should be on the next block so this is a major issue.
I did revert back to the current trunk and confirmed that this is not an issue with this PR but I was wondering why our results are not the same.

Update: I can only reproduce this with NVDA. So maybe it is just about me not being sure how to navigate when the screen reader is active 🙏

Yes! I can confirm this. I created #30620 to track the issue as it seems to be a different thing. In the video, I used VoiceOver and VO+arrow keys to navigate through the columns.

I guess we could experiment with the grid role instead of group, which would even eliminate the need for manually labeling the columns.

For now, I think this PR is good to be approved/merged as a simpler solution for the label issue. What do you think?

Copy link
Contributor

@ntsekouras ntsekouras left a comment

Choose a reason for hiding this comment

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

For now, I think this PR is good to be approved/merged as a simpler solution for the label issue. What do you think?

I personally agree with this.

packages/block-library/src/column/edit.js Outdated Show resolved Hide resolved
Copy link
Contributor

@ntsekouras ntsekouras left a comment

Choose a reason for hiding this comment

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

Thanks Diego!

@diegohaz diegohaz merged commit 6f12c97 into trunk Apr 12, 2021
@diegohaz diegohaz deleted the fix/column-label branch April 12, 2021 22:36
@github-actions github-actions bot added this to the Gutenberg 10.5 milestone Apr 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Block] Columns Affects the Columns Block [Focus] Accessibility (a11y) Changes that impact accessibility and need corresponding review (e.g. markup changes). [Type] Enhancement A suggestion for improvement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Column Block] Improve labeling of nested columns
5 participants