Command tool: Add searchLabel property to commands #50663
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
youknowriad
added
the
[Type] Bug
|
Size Change: +52 B (0%) Total Size: 1.39 MB
ℹ️ View Unchanged
|
ntsekouras
reviewed
May 16, 2023
| * @property {Function} callback Command callback. | ||
| * @property {string} name Command name. | ||
| * @property {string} label Command label. | ||
| * @property {string=} searchLabel Command label. |
There was a problem hiding this comment.
Should we use a labels object similar to the post types ones etc..? We had a similar discussion for the media inserter API.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
If we don't expect any more labels in the future, it's okay yes.
ntsekouras
reviewed
May 16, 2023
ntsekouras
approved these changes
May 16, 2023
Co-authored-by: Nik Tsekouras <ntsekouras@outlook.com>
cbravobernal
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related to #50407
What?
We're using the following library for the command center. The library requires that each command has a unique "value" prop. Also, the library relies on that prop for its "search" algorithm. This has two implications:
To address this I'm using the command "label" by default for that prop and in the cases where the label is not sufficient for the unique constraint, one can provide a "searchLabel" property in addition to the default "label" one.
Testing Instructions
1- Create a page and a template with the same name
2- Ensure the command center still works properly when searching for these.