Doc: Add documentation for ancestor property in block metadata
#40027
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
Adds documentation for the new API added in #39894
fabiankaegy
requested review from
ajitbohra,
mkaz,
ryanwelcher and
juanmaguitar
as code owners
gziolo
reviewed
Apr 4, 2022
| { "ancestor": [ "my-block/product" ] } | ||
| ``` | ||
|
|
||
| The `ancestor` property makes a block available inside the specified block types at any position of the ancestor block subtree. That allows, for example, to place a ‘Comment Content’ block inside a ‘Column’ block, as long as ‘Column’ is somewhere within a ‘Comment Template’ block. In comparrison to the `parent` property blocks that specify their `ancestor` can be placed anywhere in the subtree whilst blocks with a specified `parent` need to be direct children. |
There was a problem hiding this comment.
We should double-check that, but I believe that the other difference with the parent property is that ancestor doesn't exclude other blocks from the inserter when inside the scope of the provided ancestors.
gziolo
reviewed
Apr 4, 2022
Co-authored-by: Greg Ziółkowski <[email protected]>
gziolo
added
the
[Feature] Block API
gziolo
changed the title
ancestor propertyancestor property in block metadata
gziolo
added
the
Needs Dev Note
|
@bph - this new API will require a dev note. |
|
I've noticed this section about |
|
Is there anything missing here? Can we land this PR? |
gziolo
approved these changes
Apr 13, 2022
|
trac ticket: https://core.trac.wordpress.org/ticket/55531 |
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.
Adds documentation for the new API added in #39894