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

Command tool: Add searchLabel property to commands #50663

Merged
merged 2 commits into from
May 16, 2023
Merged

Command tool: Add searchLabel property to commands #50663

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
54d578b
Command center: Add searchLabel property to commands
youknowriad May 16, 2023
49d535c
Fix comment
youknowriad May 16, 2023
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
4 changes: 2 additions & 2 deletions packages/commands/src/components/command-menu.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ function CommandMenuLoader( { name, search, hook, setLoader, close } ) {
{ commands.map( ( command ) => (
<Command.Item
key={ command.name }
value={ command.name }
value={ command.searchLabel ?? command.label }
onSelect={ () => command.callback( { close } ) }
>
<HStack
Expand Down Expand Up @@ -110,7 +110,7 @@ export function CommandMenuGroup( { isContextual, search, setLoader, close } ) {
{ commands.map( ( command ) => (
<Command.Item
key={ command.name }
value={ command.name }
value={ command.searchLabel ?? command.label }
onSelect={ () => command.callback( { close } ) }
>
<HStack
Expand Down
2 changes: 2 additions & 0 deletions packages/commands/src/hooks/use-command.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ export default function useCommand( command ) {
name: command.name,
context: command.context,
label: command.label,
searchLabel: command.searchLabel,
icon: command.icon,
callback: currentCallback.current,
} );
Expand All @@ -35,6 +36,7 @@ export default function useCommand( command ) {
}, [
command.name,
command.label,
command.searchLabel,
command.icon,
command.context,
registerCommand,
Expand Down
11 changes: 6 additions & 5 deletions packages/commands/src/store/actions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,12 @@
*
* @typedef {Object} WPCommandConfig
*
* @property {string} name Command name.
* @property {string} label Command label.
* @property {string=} context Command context.
* @property {JSX.Element} icon Command icon.
* @property {Function} callback Command callback.
* @property {string} name Command name.
* @property {string} label Command label.
* @property {string=} searchLabel Command label.
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we use a labels object similar to the post types ones etc..? We had a similar discussion for the media inserter API.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think the common case is to have a label for each command and the search one is optional and rarely used so I prefer this approach personally.

Copy link
Contributor

Choose a reason for hiding this comment

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

If we don't expect any more labels in the future, it's okay yes.

youknowriad marked this conversation as resolved.
Show resolved Hide resolved
* @property {string=} context Command context.
* @property {JSX.Element} icon Command icon.
* @property {Function} callback Command callback.
*/

/**
Expand Down
1 change: 1 addition & 0 deletions packages/commands/src/store/reducer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ function commands( state = {}, action ) {
[ action.name ]: {
name: action.name,
label: action.label,
searchLabel: action.searchLabel,
context: action.context,
callback: action.callback,
icon: action.icon,
Expand Down
4 changes: 2 additions & 2 deletions packages/core-commands/src/add-post-type-commands.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ const { useCommand } = unlock( privateApis );

export function useAddPostTypeCommands() {
useCommand( {
name: 'add new post',
name: 'core/add-new-post',
label: __( 'Add new post' ),
icon: plus,
callback: () => {
document.location.href = 'post-new.php';
},
} );
useCommand( {
name: 'add new page',
name: 'core/add-new-page',
label: __( 'Add new page' ),
icon: plus,
callback: () => {
Expand Down
3 changes: 2 additions & 1 deletion packages/core-commands/src/site-editor-navigation-commands.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,8 @@ const getNavigationCommandLoaderPerPostType = ( postType ) =>
? { canvas: getQueryArg( window.location.href, 'canvas' ) }
: {};
return {
name: record.title?.rendered + ' ' + record.id,
name: postType + '-' + record.id,
searchLabel: record.title?.rendered + ' ' + record.id,
label: record.title?.rendered
? record.title?.rendered
: __( '(no title)' ),
Expand Down
4 changes: 2 additions & 2 deletions packages/edit-site/src/hooks/commands/use-edit-mode-commands.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ function useEditModeCommandLoader() {
? __( 'Delete template' )
: __( 'Delete template part' );
commands.push( {
name: label,
name: 'core/remove-template',
label,
icon: trash,
context: 'site-editor-edit',
Expand All @@ -55,7 +55,7 @@ function useEditModeCommandLoader() {
? __( 'Reset template' )
: __( 'Reset template part' );
commands.push( {
name: label,
name: 'core/reset-template',
label,
icon: backup,
callback: ( { close } ) => {
Expand Down