Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Add ancestor property to block-registration.md doc #45832

Merged
merged 2 commits into from
Feb 2, 2023
Merged

Docs: Add ancestor property to block-registration.md doc #45832

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
40f70d0
Add ancestor property to block-registration.md doc
nielslange Nov 17, 2022
63cf6f2
Apply suggestions from code review
gziolo Feb 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/reference-guides/block-api/block-registration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,18 @@ Setting `parent` lets a block require that it is only available when nested with
parent: [ 'core/columns' ],
```

#### ancestor (optional)

- **Type:** `Array`

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 comparison 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.


```js
// Only allow this block when it is nested at any level in a Columns block.
ancestor: [ 'core/columns' ],
```

## Block Collections

## `registerBlockCollection`
Expand Down