@wordpress/block-editor
Version:
75 lines (72 loc) • 2.24 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.default = useBlockDisplayTitle;
var _data = require("@wordpress/data");
var _blocks = require("@wordpress/blocks");
var _store = require("../../store");
/**
* WordPress dependencies
*/
/**
* Internal dependencies
*/
/**
* Returns the block's configured title as a string, or empty if the title
* cannot be determined.
*
* @example
*
* ```js
* useBlockDisplayTitle( { clientId: 'afd1cb17-2c08-4e7a-91be-007ba7ddc3a1', maximumLength: 17 } );
* ```
*
* @param {Object} props
* @param {string} props.clientId Client ID of block.
* @param {number|undefined} props.maximumLength The maximum length that the block title string may be before truncated.
* @param {string|undefined} props.context The context to pass to `getBlockLabel`.
* @return {?string} Block title.
*/
function useBlockDisplayTitle({
clientId,
maximumLength,
context
}) {
const blockTitle = (0, _data.useSelect)(select => {
if (!clientId) {
return null;
}
const {
getBlockName,
getBlockAttributes
} = select(_store.store);
const {
getBlockType,
getActiveBlockVariation
} = select(_blocks.store);
const blockName = getBlockName(clientId);
const blockType = getBlockType(blockName);
if (!blockType) {
return null;
}
const attributes = getBlockAttributes(clientId);
const label = (0, _blocks.__experimentalGetBlockLabel)(blockType, attributes, context);
// If the label is defined we prioritize it over a possible block variation title match.
if (label !== blockType.title) {
return label;
}
const match = getActiveBlockVariation(blockName, attributes);
// Label will fallback to the title if no label is defined for the current label context.
return match?.title || blockType.title;
}, [clientId, context]);
if (!blockTitle) {
return null;
}
if (maximumLength && maximumLength > 0 && blockTitle.length > maximumLength) {
const omission = '...';
return blockTitle.slice(0, maximumLength - omission.length) + omission;
}
return blockTitle;
}
//# sourceMappingURL=use-block-display-title.js.map