@wordpress/block-editor
Version:
71 lines (58 loc) • 1.8 kB
JavaScript
/**
* External dependencies
*/
import { clone } from 'lodash';
/**
* WordPress dependencies
*/
import { applyFilters, hasFilter } from '@wordpress/hooks';
import { Autocomplete } from '@wordpress/components';
import { useMemo } from '@wordpress/element';
import { getDefaultBlockName } from '@wordpress/blocks';
/**
* Internal dependencies
*/
import { useBlockEditContext } from '../block-edit/context';
import blockAutocompleter from '../../autocompleters/block';
/**
* Shared reference to an empty array for cases where it is important to avoid
* returning a new array reference on every invocation.
*
* @type {Array}
*/
const EMPTY_ARRAY = [];
/**
* Wrap the default Autocomplete component with one that supports a filter hook
* for customizing its list of autocompleters.
*
* @type {import('react').FC}
*/
function BlockEditorAutocomplete( props ) {
const { name } = useBlockEditContext();
let { completers = EMPTY_ARRAY } = props;
completers = useMemo( () => {
let filteredCompleters = completers;
if ( name === getDefaultBlockName() ) {
filteredCompleters = filteredCompleters.concat( [
blockAutocompleter,
] );
}
if ( hasFilter( 'editor.Autocomplete.completers' ) ) {
// Provide copies so filters may directly modify them.
if ( filteredCompleters === completers ) {
filteredCompleters = filteredCompleters.map( clone );
}
filteredCompleters = applyFilters(
'editor.Autocomplete.completers',
filteredCompleters,
name
);
}
return filteredCompleters;
}, [ completers, name ] );
return <Autocomplete { ...props } completers={ completers } />;
}
/**
* @see https://github.com/WordPress/gutenberg/blob/HEAD/packages/block-editor/src/components/autocomplete/README.md
*/
export default BlockEditorAutocomplete;