Document isMultiBlock param for block transforms #25952
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
oandregal
requested review from
ajitbohra,
chrisvanpatten and
mkaz
as code owners
oandregal
added
[Type] Developer Documentation
|
Size Change: +758 B (0%) Total Size: 1.19 MB
ℹ️ View Unchanged
|
ntsekouras
reviewed
Oct 9, 2020
There was a problem hiding this comment.
Thanks @nosolosw - that's definitely helpful.
I recently worked on tranforms and missed the fact that documentation was lacking, by looking the source code.
| @@ -39,6 +39,7 @@ A transformation of type `block` is an object that takes the following parameter | |||
| - **blocks** _(array)_: a list of known block types. It also accepts the wildcard value (`"*"`), meaning that the transform is available to _all_ block types (eg: all blocks can transform into `core/group`). | |||
| - **transform** _(function)_: a callback that receives the attributes and inner blocks of the block being processed. It should return a block object or an array of block objects. | |||
| - **isMatch** _(function, optional)_: a callback that receives the block attributes and should return a boolean. Returning `false` from this function will prevent the transform from being available and displayed as an option to the user. | |||
| - **isMultiblock** _(boolean, optional)_: whether the transformation can be applied when multiple blocks are selected. If this is true, the `transform` function will receive as paramaters an with the values of each selected block. False by default. | |||
There was a problem hiding this comment.
You missed the word array in will receive as paramaters an with... and maybe replace values with attributes?
Also the API returns a second argument that is an array with the InnerBlocks of each selected block.
gutenberg/packages/blocks/src/api/factory.js
Line 463 in c120818
There was a problem hiding this comment.
Good catch! Pushed a new wording. Is now clearer? Will welcome suggestions. Today, my brain has proven to have issues to enter documentation mode.
ntsekouras
approved these changes
Oct 9, 2020
docs/designers-developers/developers/block-api/block-transforms.md
Outdated
Show resolved
Hide resolved
…s.md Co-authored-by: Nik Tsekouras <ntsekouras@outlook.com>
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.
Documents the
isMultiBlockparam of block transformations.