@wordpress/block-editor
Version:
129 lines (122 loc) • 4.14 kB
JavaScript
/**
* External dependencies
*/
import clsx from 'clsx';
/**
* WordPress dependencies
*/
import { addFilter } from '@wordpress/hooks';
import { TextControl } from '@wordpress/components';
import { __ } from '@wordpress/i18n';
import { hasBlockSupport } from '@wordpress/blocks';
/**
* Internal dependencies
*/
import { InspectorControls } from '../components';
import { useBlockEditingMode } from '../components/block-editing-mode';
/**
* Filters registered block settings, extending attributes to include `className`.
*
* @param {Object} settings Original block settings.
*
* @return {Object} Filtered block settings.
*/
import { jsx as _jsx } from "react/jsx-runtime";
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;
}
function CustomClassNameControlsPure({
className,
setAttributes
}) {
const blockEditingMode = useBlockEditingMode();
if (blockEditingMode !== 'default') {
return null;
}
return /*#__PURE__*/_jsx(InspectorControls, {
group: "advanced",
children: /*#__PURE__*/_jsx(TextControl, {
__nextHasNoMarginBottom: true,
__next40pxDefaultSize: true,
autoComplete: "off",
label: __('Additional CSS class(es)'),
value: className || '',
onChange: nextValue => {
setAttributes({
className: nextValue !== '' ? nextValue : undefined
});
},
help: __('Separate multiple classes with spaces.')
})
});
}
export default {
edit: CustomClassNameControlsPure,
addSaveProps,
attributeKeys: ['className'],
hasSupport(name) {
return hasBlockSupport(name, 'customClassName', true);
}
};
/**
* 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;
}
export function addTransforms(result, source, index, results) {
if (!hasBlockSupport(result.name, 'customClassName', true)) {
return result;
}
// If the condition verifies we are probably in the presence of a wrapping transform
// e.g: nesting paragraphs in a group or columns and in that case the class should not be kept.
if (results.length === 1 && result.innerBlocks.length === source.length) {
return result;
}
// If we are transforming one block to multiple blocks or multiple blocks to one block,
// we ignore the class during the transform.
if (results.length === 1 && source.length > 1 || results.length > 1 && source.length === 1) {
return result;
}
// If we are in presence of transform between one or more block in the source
// that have one or more blocks in the result
// we apply the class on source N to the result N,
// if source N does not exists we do nothing.
if (source[index]) {
const originClassName = source[index]?.attributes.className;
// Avoid overriding classes if the transformed block already includes them.
if (originClassName && result.attributes.className === undefined) {
return {
...result,
attributes: {
...result.attributes,
className: originClassName
}
};
}
}
return result;
}
addFilter('blocks.registerBlockType', 'core/editor/custom-class-name/attribute', addAttribute);
addFilter('blocks.switchToBlockType.transformedBlock', 'core/color/addTransforms', addTransforms);
//# sourceMappingURL=custom-class-name.js.map