Where it sits
| Body | In the body | Inside its texts |
|---|---|---|
| The store’s home | Yes | Yes |
| A custom page | Yes | Yes |
| A product’s page | Yes | Yes |
| An event’s page | Yes | Yes |
| A portfolio’s page | Yes | Yes |
| A lesson | No | No |
| An article | Yes | No |
A text holds it as a <block type="event-list" props="…"></block> element: its props are those below but type, which the element’s own type names.
See Bodies for how a body holds its blocks.
Props
| Name | Type | Required | Description |
|---|---|---|---|
id |
string |
Yes | The block’s id, unique within its body. |
type |
"event-list" |
Yes | The block’s type. |
title |
string |
No | The heading over the cards; “Upcoming events” when unset. |
past |
boolean |
No | Whether past events show under the upcoming ones, the latest first; false when unset. |
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": "event-list",
"description": "The block's type."
},
"title": {
"type": "string",
"description": "The heading over the cards; \"Upcoming events\" when unset."
},
"past": {
"type": "boolean",
"description": "Whether past events show under the upcoming ones, the latest first; false when unset."
},
"hidden": {
"type": "boolean",
"description": "Whether the block is hidden: it, and every block it holds, doesn't show."
}
},
"required": [
"id",
"type"
],
"description": "The store's upcoming events as cards, the next first, and past ones under them when asked.",
"additionalProperties": false
}