Block support: Preserve aria-label value in comment delimiter #69002
+102
−11
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
t-hamano
added
[Type] Bug
t-hamano
commented
Feb 3, 2025
| @@ -15,11 +16,22 @@ import { fixCustomClassname } from './fix-custom-classname'; | |||
| * @return {WPBlock} Fixed block object | |||
| */ | |||
| export function applyBuiltInValidationFixes( block, blockType ) { | |||
There was a problem hiding this comment.
If this approach works, we may be able to apply a similar approach to the anchor support as well (See #51402).
This means adding a new function like fixAnchor() here in the future.
There was a problem hiding this comment.
I wonder if it would be more performant to have a single fixGlobalAttributes method that fixes all these cases instead of multiple parsers.
This isn't a blocker; it's just something to keep in mind after everything is merged, including the fixAnchor solution.
|
Size Change: +42 B (0%) Total Size: 1.84 MB
ℹ️ View Unchanged
|
|
Flaky tests detected in a71ec20. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/13107958080
|
t-hamano
requested review from
a team,
Mamaduka and
aaronrobertshaw
and removed request for
a team
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
|
@Mamaduka Thanks for the review! |
This was referenced Feb 4, 2025
|
This comment made me realize that I was missing some server-side processing for the |
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 #68764
Alternatives to #68735
What?
This PR changes the schema for the
ariaLabelblock support to save its value in the comment delimiter.That is, the block HTML will be updated to look like this:
Why?
The current schema references the
aria-labelattribute if it exists in the HTML markup. This works fine for the Group block, whose HTML markup is preserved, but the value cannot be referenced in the Navigation block, whose HTML markup is not preserved.As a result, as reported in #68719, when you update a template that contains a Navigation block with the
aria-labelattribute,the aria-labelvalue disappears.In Twenty Twenty-Five and Twenty Twenty-Four,
aria-labelis applied to some Navigation blocks. I believe that the disappearance of this value is a issue from an accessibility perspective.How?
Remove the
source,attribute, andselectorfields from the schema definition. This will break Group blocks that already supportariaLabel, so something needs to be done about it.I noticed that there is already a fix for block validation regarding custom class names (
fixCustomClassname()function). I used this process to automatically migrate the attributes via thefixAriaLabel()function so that block validation does not fail.To solve this problem, I considered three approaches (See #68764). I believe this approach is the best.
Testing Instructions
Group Block
Navigation Block
About,Privacy, andSocial.aria-label values should not have disappeared.aria-labelvalues should not have disappeared.