Update InnerBlocks defaultblock doc usage #56728
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
colorful-tones
added
[Type] Developer Documentation
colorful-tones
requested review from
ndiego,
fabiankaegy,
ryanwelcher and
youknowriad
youknowriad
reviewed
Dec 4, 2023
| - **Default:** - `undefined`. Determines which block type should be inserted by default and any attributes that should be set by default when the block is inserted. Takes an array in the form of `[ name: blockname, attributes: {blockAttributes} ]`. | ||
|
|
||
| ```jsx | ||
| const DEFAULT_BLOCK = [ name: 'core/paragraph', attributes: { content: 'Lorem ipsum...' } ]; |
There was a problem hiding this comment.
This seems wrong to me, it's either an array or an object, not a mix of both (this notation doesn't work in JavaScript)
There was a problem hiding this comment.
@youknowriad thanks for catching that! I've updated the accepted type to Object.
youknowriad
approved these changes
Dec 7, 2023
youknowriad
reviewed
Dec 7, 2023
Co-authored-by: Riad Benguella <[email protected]>
|
Thanks for clarifying these docs 👍 |
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?
Recently the
defaultBlockwas stabilized as part of WP 6.4 (#52083). However, theInnerBlocksREADMEdocs were incomplete. I received additional clarification from @sethrubenstein (see here: #52610 (comment))Why?
Clear instructions for extenders on how to use
defaultBlockHow?
Adds clarity to documentation.
I verified while creating a custom block with
useInnerBlocksProps(). Here is the essential code that worked.props: @sethrubenstein