UNPKG

@wordpress/block-editor

Version:
71 lines (63 loc) 1.64 kB
/** * External dependencies */ import clsx from 'clsx'; /** * WordPress dependencies */ import { addFilter } from '@wordpress/hooks'; import { hasBlockSupport } from '@wordpress/blocks'; /** * Filters registered block settings, extending attributes to include `className`. * * @param {Object} settings Original block settings. * * @return {Object} Filtered block settings. */ export function addAttribute( settings ) { if ( hasBlockSupport( settings, 'customClassName', true ) ) { // Gracefully handle if settings.attributes is undefined. settings.attributes = { ...settings.attributes, className: { type: 'string', }, }; } return settings; } /** * Override props assigned to save component to inject the className, if block * supports customClassName. This is only applied if the block's save result is an * element and not a markup string. * * @param {Object} extraProps Additional props applied to save element. * @param {Object} blockType Block type. * @param {Object} attributes Current block attributes. * * @return {Object} Filtered props applied to save element. */ export function addSaveProps( extraProps, blockType, attributes ) { if ( hasBlockSupport( blockType, 'customClassName', true ) && attributes.className ) { extraProps.className = clsx( extraProps.className, attributes.className ); } return extraProps; } addFilter( 'blocks.registerBlockType', 'core/custom-class-name/attribute', addAttribute ); export default { addSaveProps, attributeKeys: [ 'className' ], hasSupport( name ) { return hasBlockSupport( name, 'customClassName', true ); }, };