Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Block API: Allow overriding the category for block variations #28482

Merged
merged 3 commits into from
Jan 26, 2021
Merged

Block API: Allow overriding the category for block variations #28482

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
df74e16
Block API: Allow overriding the category for block variations
gziolo Jan 26, 2021
f51c381
Remove obsolete getVariations call that was disconnected in #25182
gziolo Jan 26, 2021
0b36d37
Allow overriding category for the block variation item
gziolo Jan 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/designers-developers/developers/block-api/block-registration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,7 @@ An object describing a variation defined for the block type can contain the foll
- `name` (type `string`) – The unique and machine-readable name.
- `title` (type `string`) – A human-readable variation title.
- `description` (optional, type `string`) – A detailed variation description.
- `category` (optional, type `string`) - A category classification, used in search interfaces to arrange block types by category.
- `icon` (optional, type `string` | `Object`) – An icon helping to visualize the variation. It can have the same shape as the block type.
- `isDefault` (optional, type `boolean`) – Indicates whether the current variation is the default one. Defaults to `false`.
- `attributes` (optional, type `Object`) – Values that override block attributes.
Expand Down
13 changes: 0 additions & 13 deletions packages/block-editor/src/components/inserter/search-items.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,19 +71,6 @@ export const searchBlockItems = (
find( categories, { slug: item.category } )?.title,
getCollection: ( item ) =>
collections[ item.name.split( '/' )[ 0 ] ]?.title,
getVariations: ( { variations = [] } ) =>
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No longer referenced in the code as of #25182.

Array.from(
variations.reduce(
( accumulator, { title, keywords = [] } ) => {
accumulator.add( title );
keywords.forEach( ( keyword ) =>
accumulator.add( keyword )
);
return accumulator;
},
new Set()
)
),
};

return searchItems( items, searchInput, config );
Expand Down
1 change: 1 addition & 0 deletions packages/block-editor/src/store/selectors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1402,6 +1402,7 @@ const getItemFromVariation = ( item ) => ( variation ) => ( {
icon: variation.icon || item.icon,
title: variation.title || item.title,
description: variation.description || item.description,
category: variation.category || item.category,
// If `example` is explicitly undefined for the variation, the preview will not be shown.
example: variation.hasOwnProperty( 'example' )
? variation.example
Expand Down
3 changes: 3 additions & 0 deletions packages/blocks/src/api/registration.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,9 @@ import { store as blocksStore } from '../store';
* @property {string} name The unique and machine-readable name.
* @property {string} title A human-readable variation title.
* @property {string} [description] A detailed variation description.
* @property {string} [category] Block type category classification,
* used in search interfaces to arrange
* block types by category.
* @property {WPIcon} [icon] An icon helping to visualize the variation.
* @property {boolean} [isDefault] Indicates whether the current variation is
* the default one. Defaults to `false`.
Expand Down