Enhance Block Card and Inspector Controls with Secondary Description #68438
+13
−0
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
- Added a new InspectorControls slot for secondary descriptions in BlockCard component. - Updated styles for the secondary description to include italic font and margin. - Integrated secondary description in the SearchEdit component's InspectorControls.
michalczaplinski
added
[Type] Enhancement
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
|
Size Change: +92 B (0%) Total Size: 1.84 MB
ℹ️ View Unchanged
|
|
Flaky tests detected in a1a8797. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/12562027725
|
|
I don't have a deep understanding of #68438, but in regards to this PR, it's worth noting that a similar slot existed in the past (#49819). This private slot was removed in #67189 because it's no longer used in core blocks. In any case, if we add a new slot, I recommend exposing it as a private API. Maybe we can use #49819's implementation as it is? |
|
It looks very similar to:
A private slot existed for some time and was used by the Query block, but it was removed: I think similar concerns apply here, as this slot allows us to put basically every React component, which was raised by many folks as a blocking factor. |
|
Based on the history around the previous slot and that block's Is the use case to show a different description on some cases only? Could we achieve that maybe with block variations? |
|
Thanks for your comments folks!
@ntsekouras The use case is to support the following design detail in the Instant Search functionality of the Search block: 
I hear the concerns about the potential for abuse, but I'm not convinced that it's a serious problem. I echo Greg's comment. Adding any content to the Inspector Controls with some custom CSS and JS is already possible - it's just a bit harder. What if we:
Would that be acceptable? |
|
If we decide that there is a valid use case in core to have an additional slot there (which I can see both sides of to be clear) we should make it possible for any block to use this. For that reason, I firmly believe the option to introduce this as a private API is not acceptable. |
100% agree with that. There should be consistency in how all blocks are handled. |
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.
What?
Adds a new InspectorControls slot for a secondary block description.
Why?
It's needed it for the UI that was designed for the Instant Search functionality of the Query + Search blocks (#67181)
More details in this comment: #67181 (comment)
How?
By adding the
<InspectorControls.Slot group="secondaryDescription"/>in the BlockCard and creating the relevant groups.Testing Instructions
You can test it e.g. by adding the following snippet in
packages/block-library/src/search/edit.js: