Skip to content

Commit

Permalink
Include the block variations on the inserter selector (#25182)
Browse files Browse the repository at this point in the history
Co-authored-by: Miguel Fonseca <miguelcsf@gmail.com>
  • Loading branch information
youknowriad and mcsf authored Sep 9, 2020
1 parent 6034f55 commit 28ab9ff
Show file tree
Hide file tree
Showing 10 changed files with 56 additions and 291 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -440,7 +440,7 @@ _Properties_
- _category_ `string`: Block category that the item is associated with.
- _keywords_ `Array<string>`: Keywords that can be searched to find this item.
- _isDisabled_ `boolean`: Whether or not the user should be prevented from inserting this item.
- _frecency_ `number`: Hueristic that combines frequency and recency.
- _frecency_ `number`: Heuristic that combines frequency and recency.

<a name="getLastMultiSelectedBlockClientId" href="#getLastMultiSelectedBlockClientId">#</a> **getLastMultiSelectedBlockClientId**

Expand Down
6 changes: 1 addition & 5 deletions packages/block-editor/src/autocompleters/block.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ import { useMemo } from '@wordpress/element';
*/
import { searchBlockItems } from '../components/inserter/search-items';
import useBlockTypesState from '../components/inserter/hooks/use-block-types-state';
import { includeVariationsInInserterItems } from '../components/inserter/utils';
import BlockIcon from '../components/block-icon';

const SHOWN_BLOCK_TYPES = 9;
Expand Down Expand Up @@ -98,10 +97,7 @@ function createBlockCompleter() {

const options = useMemo(
() =>
includeVariationsInInserterItems(
filteredItems,
SHOWN_BLOCK_TYPES
).map( ( blockItem ) => {
filteredItems.map( ( blockItem ) => {
const { title, icon, isDisabled } = blockItem;
return {
key: `block-${ blockItem.id }`,
Expand Down
10 changes: 2 additions & 8 deletions packages/block-editor/src/components/block-types-list/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,22 +13,16 @@ import { useEffect } from '@wordpress/element';
* Internal dependencies
*/
import InserterListItem from '../inserter-list-item';
import { includeVariationsInInserterItems } from '../inserter/utils';

function BlockTypesList( {
items = [],
onSelect,
onHover = () => {},
children,
label,
limit,
} ) {
const composite = useCompositeState();
const normalizedItems = includeVariationsInInserterItems( items, limit );
const orderId = normalizedItems.reduce(
( acc, item ) => acc + '--' + item.id,
''
);
const orderId = items.reduce( ( acc, item ) => acc + '--' + item.id, '' );

// This ensures the composite state refreshes when the list order changes.
useEffect( () => {
Expand All @@ -47,7 +41,7 @@ function BlockTypesList( {
className="block-editor-block-types-list"
aria-label={ label }
>
{ normalizedItems.map( ( item ) => {
{ items.map( ( item ) => {
return (
<InserterListItem
key={ item.id }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,6 @@ export function BlockTypesTab( {
onSelect={ onSelectItem }
onHover={ onHover }
label={ _x( 'Most used', 'blocks' ) }
limit={ MAX_SUGGESTED_ITEMS }
/>
</InserterPanel>
) }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,6 @@ function QuickInserterList( {
onSelect={ onSelectBlockType }
onHover={ onHover }
label={ __( 'Blocks' ) }
limit={ SHOWN_BLOCK_TYPES }
/>
</InserterPanel>
) }
Expand Down
50 changes: 5 additions & 45 deletions packages/block-editor/src/components/inserter/search-items.js
Original file line number Diff line number Diff line change
@@ -1,22 +1,14 @@
/**
* External dependencies
*/
import {
deburr,
differenceWith,
find,
intersectionWith,
isEmpty,
words,
} from 'lodash';
import { deburr, differenceWith, find, words } from 'lodash';

// Default search helpers
const defaultGetName = ( item ) => item.name || '';
const defaultGetTitle = ( item ) => item.title;
const defaultGetKeywords = ( item ) => item.keywords || [];
const defaultGetCategory = ( item ) => item.category;
const defaultGetCollection = () => null;
const defaultGetVariations = () => [];

/**
* Sanitizes the search input string.
Expand Down Expand Up @@ -92,33 +84,8 @@ export const searchBlockItems = (
)
),
};
return searchItems( items, searchInput, config ).map( ( item ) => {
if ( isEmpty( item.variations ) ) {
return item;
}

const matchedVariations = item.variations.filter(
( { title, keywords = [] } ) => {
return (
intersectionWith(
normalizedSearchTerms,
getNormalizedSearchTerms( title ).concat( keywords ),
( termToMatch, labelTerm ) =>
labelTerm.includes( termToMatch )
).length > 0
);
}
);
// When no variations matched, fallback to all variations.
if ( isEmpty( matchedVariations ) ) {
return item;
}

return {
...item,
variations: matchedVariations,
};
} );
return searchItems( items, searchInput, config );
};

/**
Expand Down Expand Up @@ -162,15 +129,13 @@ export function getItemSearchRank( item, searchTerm, config = {} ) {
getKeywords = defaultGetKeywords,
getCategory = defaultGetCategory,
getCollection = defaultGetCollection,
getVariations = defaultGetVariations,
} = config;

const name = getName( item );
const title = getTitle( item );
const keywords = getKeywords( item );
const category = getCategory( item );
const collection = getCollection( item );
const variations = getVariations( item );

const normalizedSearchInput = normalizeSearchInput( searchTerm );
const normalizedTitle = normalizeSearchInput( title );
Expand All @@ -185,14 +150,9 @@ export function getItemSearchRank( item, searchTerm, config = {} ) {
} else if ( normalizedTitle.startsWith( normalizedSearchInput ) ) {
rank += 20;
} else {
const terms = [
name,
title,
...keywords,
category,
collection,
...variations,
].join( ' ' );
const terms = [ name, title, ...keywords, category, collection ].join(
' '
);
const normalizedSearchTerms = words( normalizedSearchInput );
const unmatchedTerms = removeMatchingTerms(
normalizedSearchTerms,
Expand Down
71 changes: 0 additions & 71 deletions packages/block-editor/src/components/inserter/test/search-items.js
Original file line number Diff line number Diff line change
Expand Up @@ -131,75 +131,4 @@ describe( 'searchBlockItems', () => {
)
).toEqual( [ youtubeItem ] );
} );

it( 'should match words using also variations and return all matched variations', () => {
const filteredItems = searchBlockItems(
items,
categories,
collections,
'variation'
);

expect( filteredItems ).toHaveLength( 1 );
expect( filteredItems[ 0 ].variations ).toHaveLength( 3 );
} );

it( 'should match words using also variations and filter out unmatched variations', () => {
const filteredItems = searchBlockItems(
items,
categories,
collections,
'variations two three'
);

expect( filteredItems ).toHaveLength( 1 );
expect( filteredItems[ 0 ].variations ).toHaveLength( 2 );
expect( filteredItems[ 0 ].variations[ 0 ].title ).toBe(
'Variation Two'
);
expect( filteredItems[ 0 ].variations[ 1 ].title ).toBe(
'Variation Three'
);
} );

it( 'should search in variation keywords if exist', () => {
const filteredItems = searchBlockItems(
items,
categories,
collections,
'music'
);
expect( filteredItems ).toHaveLength( 1 );
const [ { title, variations } ] = filteredItems;
expect( title ).toBe( 'With Variations' );
expect( variations[ 0 ].title ).toBe( 'Variation Three' );
} );

it( 'should search in both blocks/variation keywords if exist', () => {
const filteredItems = searchBlockItems(
items,
categories,
collections,
'random'
);
expect( filteredItems ).toHaveLength( 2 );
expect( filteredItems ).toEqual(
expect.arrayContaining( [
expect.objectContaining( { title: 'Paragraph' } ),
expect.objectContaining( {
title: 'With Variations',
variations: [
{
name: 'variation-three',
title: 'Variation Three',
keywords: expect.arrayContaining( [
'music',
'random',
] ),
},
],
} ),
] )
);
} );
} );
99 changes: 0 additions & 99 deletions packages/block-editor/src/components/inserter/test/utils.js

This file was deleted.

Loading

0 comments on commit 28ab9ff

Please sign in to comment.