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 variations key to block.json JSON schema definition #42539

Merged
merged 8 commits into from
Jul 20, 2022
Merged

Docs: Add variations key to block.json JSON schema definition #42539

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
a329291
add variations key to block.json JSON schema definition
fabiankaegy Jul 19, 2022
1e170ed
fix add string suggestions to variation category
fabiankaegy Jul 19, 2022
e70e99e
fix type of variation icon to only string
fabiankaegy Jul 20, 2022
8d52b84
Merge branch 'trunk' into fix/add-variations-to-block-schema
fabiankaegy Jul 20, 2022
4c8f4ff
add Variations section in block metadata documentation
fabiankaegy Jul 20, 2022
ca0d80c
fix type of variations in documentation
fabiankaegy Jul 20, 2022
081f27e
add variations to overall block.json example
fabiankaegy Jul 20, 2022
920ffa8
Update docs/reference-guides/block-api/block-metadata.md
fabiankaegy Jul 20, 2022
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
28 changes: 28 additions & 0 deletions docs/reference-guides/block-api/block-metadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -421,6 +421,34 @@ It provides structured example data for the block. This data is used to construc

See the [the example documentation](/docs/reference-guides/block-api/block-registration.md#example-optional) for more details.

### Variations

- Type: `array`
fabiankaegy marked this conversation as resolved.
Show resolved Hide resolved
- Optional
- Localized: Yes (`title`, `description`, and `keywords` of each variation only)
- Property: `variations`
fabiankaegy marked this conversation as resolved.
Show resolved Hide resolved

```json
{
fabiankaegy marked this conversation as resolved.
Show resolved Hide resolved
"variations": [
{
"name": "example",
"title": "Example",
"attributes": {
"level": 2,
"message": "This is an example!"
},
"scope": [ "block" ],
"isActive": [ "level" ]
}
]
}
```

_Note: JavaScript functions (isActive) and React elements (icon) can't be used in block.json_
fabiankaegy marked this conversation as resolved.
Show resolved Hide resolved

See the [the variations documentation](/docs/reference-guides/block-api/block-variations.md) for more details.

### Editor Script

- Type: `WPDefinedAsset` ([learn more](#wpdefinedasset))
Expand Down