Where it sits
| Body | In the body | Inside its texts |
|---|---|---|
| The store’s home | No | No |
| A custom page | No | No |
| A product’s page | Yes | No |
| An event’s page | Yes | No |
| A portfolio’s page | Yes | No |
| A lesson | No | No |
| An article | No | No |
See Bodies for how a body holds its blocks.
It holds other blocks: each nested block is one of the types this reference lists that its body takes, as the whole block schema reads it.
Props
| Name | Type | Required | Description |
|---|---|---|---|
id |
string |
Yes | The block’s id, unique within its body. |
type |
"aside" |
Yes | The block’s type. |
target |
"main" or "aside" |
No | Which column: main or aside (the side one). Defaults to "aside". |
priority |
"low" or "high" |
No | Which column comes first on a narrow screen: the high one. |
blocks |
array of block |
Yes | The blocks it holds. |
hidden |
boolean |
No | Whether the block is hidden: it, and every block it holds, doesn’t show. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The block's id, unique within its body."
},
"type": {
"type": "string",
"const": "aside",
"description": "The block's type."
},
"target": {
"default": "aside",
"type": "string",
"enum": [
"main",
"aside"
],
"description": "Which column: `main` or `aside` (the side one)."
},
"priority": {
"type": "string",
"enum": [
"low",
"high"
],
"description": "Which column comes first on a narrow screen: the `high` one."
},
"blocks": {
"type": "array",
"items": {
"$ref": "https://docs.sherpo.io/overview/blocks/schema.json"
},
"description": "The blocks it holds."
},
"hidden": {
"type": "boolean",
"description": "Whether the block is hidden: it, and every block it holds, doesn't show."
}
},
"required": [
"id",
"type",
"blocks"
],
"description": "A column of a product's page: the main one, or the side one.",
"additionalProperties": false
}