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

Block support: Preserve aria-label value in comment delimiter #69002

Merged
merged 1 commit into from
Feb 4, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 3 additions & 8 deletions packages/block-editor/src/hooks/aria-label.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,6 @@
import { addFilter } from '@wordpress/hooks';
import { hasBlockSupport } from '@wordpress/blocks';

const ARIA_LABEL_SCHEMA = {
type: 'string',
source: 'attribute',
attribute: 'aria-label',
selector: '*',
};

/**
* Filters registered block settings, extending attributes with ariaLabel using aria-label
* of the first node.
Expand All @@ -28,7 +21,9 @@ export function addAttribute( settings ) {
// Gracefully handle if settings.attributes is undefined.
settings.attributes = {
...settings.attributes,
ariaLabel: ARIA_LABEL_SCHEMA,
ariaLabel: {
type: 'string',
},
};
}

Expand Down
18 changes: 15 additions & 3 deletions packages/blocks/src/api/parser/apply-built-in-validation-fixes.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
* Internal dependencies
*/
import { fixCustomClassname } from './fix-custom-classname';
import { fixAriaLabel } from './fix-aria-label';

/**
* Attempts to fix block invalidation by applying build-in validation fixes
Expand All @@ -15,11 +16,22 @@ import { fixCustomClassname } from './fix-custom-classname';
* @return {WPBlock} Fixed block object
*/
export function applyBuiltInValidationFixes( block, blockType ) {
Copy link
Contributor Author

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.

Copy link
Member

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.

const updatedBlockAttributes = fixCustomClassname(
block.attributes,
const { attributes, originalContent } = block;
let updatedBlockAttributes = attributes;

// Fix block invalidation for className attribute.
updatedBlockAttributes = fixCustomClassname(
attributes,
blockType,
originalContent
);
// Fix block invalidation for ariaLabel attribute.
updatedBlockAttributes = fixAriaLabel(
updatedBlockAttributes,
blockType,
block.originalContent
originalContent
);

return {
...block,
attributes: updatedBlockAttributes,
Expand Down
51 changes: 51 additions & 0 deletions packages/blocks/src/api/parser/fix-aria-label.js
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;
}
33 changes: 33 additions & 0 deletions packages/blocks/src/api/parser/test/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,39 @@ describe( 'block parser', () => {
} );
} );

it( 'should apply aria-label block validation fixes', () => {
registerBlockType( 'core/test-block', {
...defaultBlockSettings,
attributes: {
fruit: {
type: 'string',
source: 'text',
selector: 'div',
},
},
supports: {
ariaLabel: true,
},
save: ( { attributes } ) => (
<div aria-label={ attributes.ariaLabel }>
{ attributes.fruit }
</div>
),
} );

const block = parseRawBlock( {
blockName: 'core/test-block',
innerHTML: '<div aria-label="custom-label">Bananas</div>',
attrs: { fruit: 'Bananas' },
} );

expect( block.name ).toEqual( 'core/test-block' );
expect( block.attributes ).toEqual( {
fruit: 'Bananas',
ariaLabel: 'custom-label',
} );
} );

it( 'should create the requested block if it exists', () => {
registerBlockType( 'core/test-block', defaultBlockSettings );

Expand Down
Loading