Table of Contents: Try maintaining block example attributes #65549
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
aaronrobertshaw
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. |
aaronrobertshaw
commented
Sep 23, 2024
Comment on lines
150
to
157
| const blockType = useSelect( | ||
| ( select ) => | ||
| select( blocksStore ).getBlockType( 'core/table-of-contents' ), | ||
| [] | ||
| ); | ||
| const isExample = | ||
| JSON.stringify( blockType.example.attributes.headings ) === | ||
| JSON.stringify( headings ); |
There was a problem hiding this comment.
I struggled to find a better option to avoid the useObserveHeadings hook overriding arbitrary block example attributes. More than happy to hear better approaches if you have them 🙏
|
Size Change: +74 B (0%) Total Size: 1.77 MB
ℹ️ View Unchanged
|
ramonjd
reviewed
Sep 23, 2024
| @@ -19,6 +19,28 @@ export const settings = { | |||
| icon, | |||
| edit, | |||
| save, | |||
| example: { | |||
There was a problem hiding this comment.
Could this be moved to block.json?
I think the example check above might be unnecessary if we use innerBlocks (?)
"example": {
"innerBlocks": [
{
"name": "core/heading",
"attributes": {
"level": 2,
"content": "Heading"
}
},
{
"name": "core/heading",
"attributes": {
"level": 3,
"content": "Subheading"
}
},
{
"name": "core/heading",
"attributes": {
"level": 2,
"content": "Heading"
}
},
{
"name": "core/heading",
"attributes": {
"level": 3,
"content": "Subheading"
}
}
],
"attributes": {
"headings": [
{
"content": "Heading",
"level": 2
},
{
"content": "Subheading",
"level": 3
},
{
"content": "Heading",
"level": 2
},
{
"content": "Subheading",
"level": 3
}
]
}
},
There was a problem hiding this comment.
Yep, that works, thanks 🙇
I take it that the definition of the innerBlocks and them being rendered initially for the example means there are heading blocks in the registry. That then leads the useObserveHeadings hook to find those before updating the block's headings attribute.
If I remove the attributes.headings value, you can see the block example start in the placeholder state then update to match the provided inner blocks.
I've pushed a commit using the suggested approach.
There was a problem hiding this comment.
I take it that the definition of the innerBlocks and them being rendered initially for the example means there are heading blocks in the registry. That then leads the useObserveHeadings hook to find those before updating the block's headings attribute.
That sounds legit. My brain stops functioning when I see something working. 😄
ramonjd
added a commit
that referenced
this pull request
Sep 23, 2024
Co-authored-by: aaronrobertshaw <[email protected]> Co-authored-by: ramonjd <[email protected]>
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.
Part of: #64707
Related: #65430
What?
Adds block example for the Table of Contents.
Why?
The Style Book is being iterated on and part of that effort is to ensure the desired blocks are shown there. Currently, the Table of Contents blocks only shows a placeholder which isn't a great experience when the point of the Style Book is to see how it would actually look.
How?
Defines a block example containing both a
headingsattribute value and corresponding inner blocks.The
innerBlocksdefinition means there are heading blocks matching theheadingsattribute so theuseObserveHeadingshook doesn't override the example attributes with an empty set.Testing Instructions
Screenshots or screencast