-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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
Block support: Preserve aria-label value in comment delimiter #69002
Merged
+102
−11
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
/** | ||
* Internal dependencies | ||
*/ | ||
import { hasBlockSupport } from '../registration'; | ||
import { parseWithAttributeSchema } from './get-block-attributes'; | ||
|
||
const ARIA_LABEL_ATTR_SCHEMA = { | ||
type: 'string', | ||
source: 'attribute', | ||
selector: '[data-aria-label] > *', | ||
attribute: 'aria-label', | ||
}; | ||
|
||
/** | ||
* Given an HTML string, returns the aria-label attribute assigned to | ||
* the root element in the markup. | ||
* | ||
* @param {string} innerHTML Markup string from which to extract the aria-label. | ||
* | ||
* @return {string} The aria-label assigned to the root element. | ||
*/ | ||
export function getHTMLRootElementAriaLabel( innerHTML ) { | ||
const parsed = parseWithAttributeSchema( | ||
`<div data-aria-label>${ innerHTML }</div>`, | ||
ARIA_LABEL_ATTR_SCHEMA | ||
); | ||
return parsed; | ||
} | ||
|
||
/** | ||
* Given a parsed set of block attributes, if the block supports ariaLabel | ||
* and an aria-label attribute is found, the aria-label attribute is assigned | ||
* to the block attributes. | ||
* | ||
* @param {Object} blockAttributes Original block attributes. | ||
* @param {Object} blockType Block type settings. | ||
* @param {string} innerHTML Original block markup. | ||
* | ||
* @return {Object} Filtered block attributes. | ||
*/ | ||
export function fixAriaLabel( blockAttributes, blockType, innerHTML ) { | ||
if ( ! hasBlockSupport( blockType, 'ariaLabel', false ) ) { | ||
return blockAttributes; | ||
} | ||
const modifiedBlockAttributes = { ...blockAttributes }; | ||
const ariaLabel = getHTMLRootElementAriaLabel( innerHTML ); | ||
if ( ariaLabel ) { | ||
modifiedBlockAttributes.ariaLabel = ariaLabel; | ||
} | ||
return modifiedBlockAttributes; | ||
} |
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.