@wordpress/block-library
Version:
Block library for the WordPress editor.
8 lines (7 loc) • 8.55 kB
Source Map (JSON)
{
"version": 3,
"sources": ["../../../src/navigation-link/shared/use-block-suggestions.js"],
"sourcesContent": ["import { __, sprintf } from '@wordpress/i18n';\nimport { speak } from '@wordpress/a11y';\nimport { createElement, useCallback } from '@wordpress/element';\nimport { useDispatch, useSelect } from '@wordpress/data';\nimport {\n\tcreateBlock,\n\tcreateBlocksFromInnerBlocksTemplate,\n} from '@wordpress/blocks';\nimport {\n\tBlockIcon,\n\tstore as blockEditorStore,\n\tprivateApis as blockEditorPrivateApis,\n} from '@wordpress/block-editor';\nimport { unlock } from '../../lock-unlock';\n\nconst { searchItems, normalizeString } = unlock( blockEditorPrivateApis );\n\n/**\n * The `type` of a suggestion that inserts a block rather than setting a link.\n */\nexport const BLOCK_SUGGESTION_TYPE = 'block';\n\n/**\n * Whether a suggestion inserts a block rather than setting a link.\n *\n * The `type` alone is not enough: a site can register a post type called\n * \"block\", whose results arrive with that type. Only a block suggestion\n * carries the inserter item it was made from.\n *\n * @param {Object} suggestion A link suggestion.\n * @return {boolean} Whether it is a block suggestion.\n */\nexport function isBlockSuggestion( suggestion ) {\n\treturn (\n\t\tsuggestion?.type === BLOCK_SUGGESTION_TYPE &&\n\t\ttypeof suggestion.blockItemId === 'string'\n\t);\n}\n\n/**\n * The link variations are left out: searching already finds the pages, posts\n * and terms they would link to.\n */\nconst EXCLUDED_BLOCK_NAMES = [ 'core/navigation-link' ];\n\n// Match on what a block is called, not on its description or category, which\n// would list blocks for words that only happen to describe them.\nconst SEARCH_FIELDS = [\n\t{ get: ( item ) => item.title },\n\t{ get: ( item ) => item.keywords },\n];\n\n/**\n * Adds the blocks that match a search to the link suggestions.\n *\n * A block whose title starts with the search is what was asked for by name,\n * so it goes before the links. Any other matching block goes after them.\n *\n * @param {Array} suggestions Link suggestions.\n * @param {Array} blockItems Inserter items the Navigation allows.\n * @param {string} searchTerm What the user typed.\n * @return {Array} The suggestions, with any matching blocks added.\n */\nexport function addBlockSuggestions( suggestions, blockItems, searchTerm ) {\n\tif ( ! searchTerm?.trim() ) {\n\t\treturn suggestions;\n\t}\n\n\tconst matches = searchItems( blockItems, searchTerm, {\n\t\tfields: SEARCH_FIELDS,\n\t\tfilter: ( item ) =>\n\t\t\t! item.isDisabled && ! EXCLUDED_BLOCK_NAMES.includes( item.name ),\n\t} );\n\n\tif ( ! matches.length ) {\n\t\treturn suggestions;\n\t}\n\n\tconst search = normalizeString( searchTerm.trim() );\n\tconst before = [];\n\tconst after = [];\n\n\tfor ( const item of matches ) {\n\t\tconst suggestion = {\n\t\t\tid: item.id,\n\t\t\tblockItemId: item.id,\n\t\t\ttype: BLOCK_SUGGESTION_TYPE,\n\t\t\ttitle: item.title,\n\t\t\ticon: createElement( BlockIcon, { icon: item.icon } ),\n\t\t\ttypeLabel: __( 'Block' ),\n\t\t};\n\n\t\tif ( normalizeString( item.title ).startsWith( search ) ) {\n\t\t\tbefore.push( suggestion );\n\t\t} else {\n\t\t\tafter.push( suggestion );\n\t\t}\n\t}\n\n\treturn [ ...before, ...suggestions, ...after ];\n}\n\n/**\n * Lists the blocks a Navigation allows in a link's search results, and\n * inserts the one that is chosen.\n *\n * The allowed blocks are read when a search runs, not subscribed to, so an\n * open link UI does no work as the editor changes.\n *\n * @param {Object} options Hook options.\n * @param {string} options.clientId Client ID of the link or submenu.\n * @param {boolean} options.isEnabled Whether to list blocks at all.\n * @param {Function=} options.onBlockInsert Called with the inserted block by a\n * caller that tracks the new link,\n * such as the list view.\n * @param {Function=} options.onClose Closes the link UI.\n * @return {{ transformSuggestions: Function|undefined, insertBlockFromSuggestion: Function }}\n * The `transformSuggestions` to give LinkControl, and the handler for a chosen\n * block suggestion.\n */\nexport function useBlockSuggestions( {\n\tclientId,\n\tisEnabled,\n\tonBlockInsert,\n\tonClose,\n} ) {\n\tconst {\n\t\tgetBlockIndex,\n\t\tgetBlockOrder,\n\t\tgetBlockRootClientId,\n\t\tgetInserterItems,\n\t} = useSelect( blockEditorStore );\n\tconst { insertBlock, replaceBlock } = useDispatch( blockEditorStore );\n\n\tconst transformSuggestions = useCallback(\n\t\t( suggestions, { isInitialSuggestions, searchTerm } ) =>\n\t\t\tisInitialSuggestions\n\t\t\t\t? suggestions\n\t\t\t\t: addBlockSuggestions(\n\t\t\t\t\t\tsuggestions,\n\t\t\t\t\t\tgetInserterItems( getBlockRootClientId( clientId ) ),\n\t\t\t\t\t\tsearchTerm\n\t\t\t\t\t),\n\t\t[ clientId, getBlockRootClientId, getInserterItems ]\n\t);\n\n\tconst insertBlockFromSuggestion = ( itemId ) => {\n\t\tconst rootClientId = getBlockRootClientId( clientId );\n\t\tconst item = getInserterItems( rootClientId ).find(\n\t\t\t( { id } ) => id === itemId\n\t\t);\n\n\t\tif ( ! item ) {\n\t\t\treturn;\n\t\t}\n\n\t\tconst block = createBlock(\n\t\t\titem.name,\n\t\t\titem.initialAttributes,\n\t\t\tcreateBlocksFromInnerBlocksTemplate( item.innerBlocks )\n\t\t);\n\t\tconst index = getBlockIndex( clientId );\n\n\t\tif ( onBlockInsert ) {\n\t\t\t// A caller that tracks the new link, such as the list view, removes\n\t\t\t// it itself once told about the block, as with the \"Add block\" pane.\n\t\t\tinsertBlock( block, index, rootClientId, false );\n\t\t\tonBlockInsert( block );\n\t\t} else if ( getBlockOrder( clientId ).length ) {\n\t\t\t// A submenu keeps its items, so the block goes before it, where the\n\t\t\t// \"Add block\" pane puts it.\n\t\t\tinsertBlock( block, index, rootClientId );\n\t\t\tonClose?.();\n\t\t} else {\n\t\t\t// An empty link is replaced by the block.\n\t\t\treplaceBlock( clientId, block );\n\t\t}\n\n\t\tspeak(\n\t\t\tsprintf(\n\t\t\t\t/* translators: %s: The title of the block that was added. */\n\t\t\t\t__( '%s block added.' ),\n\t\t\t\titem.title\n\t\t\t)\n\t\t);\n\t};\n\n\treturn {\n\t\ttransformSuggestions: isEnabled ? transformSuggestions : undefined,\n\t\tinsertBlockFromSuggestion,\n\t};\n}\n"],
"mappings": ";AAAA,SAAS,IAAI,eAAe;AAC5B,SAAS,aAAa;AACtB,SAAS,eAAe,mBAAmB;AAC3C,SAAS,aAAa,iBAAiB;AACvC;AAAA,EACC;AAAA,EACA;AAAA,OACM;AACP;AAAA,EACC;AAAA,EACA,SAAS;AAAA,EACT,eAAe;AAAA,OACT;AACP,SAAS,cAAc;AAEvB,IAAM,EAAE,aAAa,gBAAgB,IAAI,OAAQ,sBAAuB;AAKjE,IAAM,wBAAwB;AAY9B,SAAS,kBAAmB,YAAa;AAC/C,SACC,YAAY,SAAS,yBACrB,OAAO,WAAW,gBAAgB;AAEpC;AAMA,IAAM,uBAAuB,CAAE,sBAAuB;AAItD,IAAM,gBAAgB;AAAA,EACrB,EAAE,KAAK,CAAE,SAAU,KAAK,MAAM;AAAA,EAC9B,EAAE,KAAK,CAAE,SAAU,KAAK,SAAS;AAClC;AAaO,SAAS,oBAAqB,aAAa,YAAY,YAAa;AAC1E,MAAK,CAAE,YAAY,KAAK,GAAI;AAC3B,WAAO;AAAA,EACR;AAEA,QAAM,UAAU,YAAa,YAAY,YAAY;AAAA,IACpD,QAAQ;AAAA,IACR,QAAQ,CAAE,SACT,CAAE,KAAK,cAAc,CAAE,qBAAqB,SAAU,KAAK,IAAK;AAAA,EAClE,CAAE;AAEF,MAAK,CAAE,QAAQ,QAAS;AACvB,WAAO;AAAA,EACR;AAEA,QAAM,SAAS,gBAAiB,WAAW,KAAK,CAAE;AAClD,QAAM,SAAS,CAAC;AAChB,QAAM,QAAQ,CAAC;AAEf,aAAY,QAAQ,SAAU;AAC7B,UAAM,aAAa;AAAA,MAClB,IAAI,KAAK;AAAA,MACT,aAAa,KAAK;AAAA,MAClB,MAAM;AAAA,MACN,OAAO,KAAK;AAAA,MACZ,MAAM,cAAe,WAAW,EAAE,MAAM,KAAK,KAAK,CAAE;AAAA,MACpD,WAAW,GAAI,OAAQ;AAAA,IACxB;AAEA,QAAK,gBAAiB,KAAK,KAAM,EAAE,WAAY,MAAO,GAAI;AACzD,aAAO,KAAM,UAAW;AAAA,IACzB,OAAO;AACN,YAAM,KAAM,UAAW;AAAA,IACxB;AAAA,EACD;AAEA,SAAO,CAAE,GAAG,QAAQ,GAAG,aAAa,GAAG,KAAM;AAC9C;AAoBO,SAAS,oBAAqB;AAAA,EACpC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACD,GAAI;AACH,QAAM;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACD,IAAI,UAAW,gBAAiB;AAChC,QAAM,EAAE,aAAa,aAAa,IAAI,YAAa,gBAAiB;AAEpE,QAAM,uBAAuB;AAAA,IAC5B,CAAE,aAAa,EAAE,sBAAsB,WAAW,MACjD,uBACG,cACA;AAAA,MACA;AAAA,MACA,iBAAkB,qBAAsB,QAAS,CAAE;AAAA,MACnD;AAAA,IACD;AAAA,IACH,CAAE,UAAU,sBAAsB,gBAAiB;AAAA,EACpD;AAEA,QAAM,4BAA4B,CAAE,WAAY;AAC/C,UAAM,eAAe,qBAAsB,QAAS;AACpD,UAAM,OAAO,iBAAkB,YAAa,EAAE;AAAA,MAC7C,CAAE,EAAE,GAAG,MAAO,OAAO;AAAA,IACtB;AAEA,QAAK,CAAE,MAAO;AACb;AAAA,IACD;AAEA,UAAM,QAAQ;AAAA,MACb,KAAK;AAAA,MACL,KAAK;AAAA,MACL,oCAAqC,KAAK,WAAY;AAAA,IACvD;AACA,UAAM,QAAQ,cAAe,QAAS;AAEtC,QAAK,eAAgB;AAGpB,kBAAa,OAAO,OAAO,cAAc,KAAM;AAC/C,oBAAe,KAAM;AAAA,IACtB,WAAY,cAAe,QAAS,EAAE,QAAS;AAG9C,kBAAa,OAAO,OAAO,YAAa;AACxC,gBAAU;AAAA,IACX,OAAO;AAEN,mBAAc,UAAU,KAAM;AAAA,IAC/B;AAEA;AAAA,MACC;AAAA;AAAA,QAEC,GAAI,iBAAkB;AAAA,QACtB,KAAK;AAAA,MACN;AAAA,IACD;AAAA,EACD;AAEA,SAAO;AAAA,IACN,sBAAsB,YAAY,uBAAuB;AAAA,IACzD;AAAA,EACD;AACD;",
"names": []
}