docs: improvements and fixes to blocks documentation#13782
Merged
GermanJablo merged 2 commits intomainfrom Sep 12, 2025
Merged
Conversation
GermanJablo
commented
Sep 11, 2025
Comment on lines
85
to
-88
|
|
||
| | Option | Description | | ||
| | ---------------------- | -------------------------------------------------------------------------- | | ||
| | **`group`** | Text or localization object used to group this Block in the Blocks Drawer. | | ||
| | **`initCollapsed`** | Set the initial collapsed state | | ||
| | **`isSortable`** | Disable order sorting by setting this value to `false` | | ||
| | **`disableBlockName`** | Hide the blockName field by setting this value to `true` | |
Contributor
Author
There was a problem hiding this comment.
This is an example of how we were mixing up concepts. Two of these properties are part of the block field's admin config, while the other two are from the blocks' admin config.
GermanJablo
commented
Sep 11, 2025
Comment on lines
+167
to
+173
| | Option | Description | | ||
| | ---------------------- | -------------------------------------------------------------------------- | | ||
| | **`components.Block`** | Custom component for replacing the Block, including the header. | | ||
| | **`components.Label`** | Custom component for replacing the Block Label. | | ||
| | **`disableBlockName`** | Hide the blockName field by setting this value to `true`. | | ||
| | **`group`** | Text or localization object used to group this Block in the Blocks Drawer. | | ||
| | **`custom`** | Extension point for adding custom data (e.g. for plugins) | |
Contributor
Author
There was a problem hiding this comment.
I found another undocumented property in types: jsx. @AlessioGr Do you know anything about this?
GermanJablo
changed the title
PatrikKozak
approved these changes
Sep 12, 2025
Contributor
|
🚀 This is included in version v3.56.0 |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
The information about the block field and the blocks themselves wasn't separated in the documentation, and in fact, there were times when they were confused and incorrectly mixed.
This caused confusion among our users.
This PR closes an issue, a discussion, and another PR that arose because it wasn't clear that the
blockNamecould be programmatically modified with the block's content. This is possible throughadmin.components.Label, which isn't the best name, as it changes thelabeland thenameof the block, two different concepts.I've added a section to the documentation that I think will make all of this much clearer.
Before:
After:
Replaces #12135
Fixes #12112 & addresses #4648