Improve the image block lightbox translations, labelling, and escaping #50962
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
afercia
added
[Type] Bug
afercia
changed the title
|
Size Change: 0 B Total Size: 1.41 MB ℹ️ View Unchanged
|
cbravobernal
added
the
Backport to Gutenberg RC
|
Flaky tests detected in 5c3ca57. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/5080636880
|
alexstine
approved these changes
May 26, 2023
artemiomorales
approved these changes
May 29, 2023
|
Cherry picked for Gutenberg 15.9 RC2 |
cbravobernal
pushed a commit
that referenced
this pull request
May 29, 2023
#50962) * Fix translatable labels and escaping. * Improve labels. * Adjust test. * Simplify labels and use aria-label for the dialog. * Add missing button type attribute. * Fix typo.
juanfra
reviewed
May 29, 2023
| @@ -92,10 +93,10 @@ function render_block_core_image( $attributes, $content ) { | |||
| data-wp-on.mousewheel="actions.core.image.hideLightbox" | |||
| data-wp-on.click="actions.core.image.hideLightbox" | |||
| > | |||
| <button aria-label="Close lightbox" class="close-button" data-wp-on.click="actions.core.image.hideLightbox"> | |||
| <button type="button" aria-label="$close_button_label" class="close-button" data-wp-on.click="actions.core.image.hideLightbox"> | |||
There was a problem hiding this comment.
We should probably also escape the close button label here.
juanfra
reviewed
May 29, 2023
| @@ -82,7 +83,7 @@ function render_block_core_image( $attributes, $content ) { | |||
| $body_content | |||
| <div data-wp-body="" class="wp-lightbox-overlay" | |||
| data-wp-bind.role="selectors.core.image.roleAttribute" | |||
| aria-labelledby="$image_lightbox_id" | |||
| aria-label="$dialog_label" | |||
There was a problem hiding this comment.
We should probably also escape the dialog label here.
There was a problem hiding this comment.
Only user provided texts are escaped in WordPress core.
cbravobernal
removed
the
Backport to Gutenberg RC
sethrubenstein
pushed a commit
to pewresearch/gutenberg
that referenced
this pull request
Jul 13, 2023
WordPress#50962) * Fix translatable labels and escaping. * Improve labels. * Adjust test. * Simplify labels and use aria-label for the dialog. * Add missing button type attribute. * Fix typo.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #50959
Note: this PR is a the result of a team coding session with @aristath, @carolinan, @SergeyBiryukov, and @afercia.
What?
lightboxis. That term is way too technical. As a user, I'm only interested in understanding what an UI control does.type="button"attribute: potentially, the may submit a form when the block is rendered within a form.Why?
How?
lightboxand simplifies the labels. New labels:aria-labellednbytoaria-label: this allows to provide a default label. Also, prevents potentially duplicated IDs and allows to simplify the code.type="button"attributes.Nnte:
The Close button misses a tooltip. Icon-buttons should always visually expose their accessible name. In the admin, we're using the Tooltip component for this. Not sure how to solve this for the front end so I'm keeping this point out of this PR for now.
Testing Instructions
Core blocksin the Gutenberg Experiments settings page.Enlarge image: {alt text here}.Enlarge image.Image.aria-haspopup="dialog"attribute makes screen reader announce something along the lines ofdialog pop-up.dialogorweb dialog.Testing Instructions for Keyboard
Screenshots or screencast
Screenshots with Safari + VoiceOver announcing the Lightbox button and dialog:
Button:
Dialog: