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 | Yes | Yes |
| An article | Yes | Yes |
A text holds it as a <block type="carousel" 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.
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 |
"carousel" |
Yes | The block’s type. |
title |
string |
No | Kept, but not shown. |
subtitle |
string |
No | Kept, but not shown. |
description |
string |
No | Kept, but not shown. |
items |
array of block |
Yes | The slides, one block each. |
autoplay |
boolean |
No | Kept, but has no effect. |
alignment |
"start" or "center" or "end" |
No | Kept, but not shown. |
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": "carousel",
"description": "The block's type."
},
"title": {
"type": "string",
"description": "Kept, but not shown."
},
"subtitle": {
"type": "string",
"description": "Kept, but not shown."
},
"description": {
"type": "string",
"description": "Kept, but not shown."
},
"items": {
"type": "array",
"items": {
"$ref": "https://docs.sherpo.io/overview/blocks/schema.json"
},
"description": "The slides, one block each."
},
"autoplay": {
"type": "boolean",
"description": "Kept, but has no effect."
},
"alignment": {
"type": "string",
"enum": [
"start",
"center",
"end"
],
"description": "Kept, but not shown."
},
"hidden": {
"type": "boolean",
"description": "Whether the block is hidden: it, and every block it holds, doesn't show."
}
},
"required": [
"id",
"type",
"items"
],
"description": "A row of slides, one block each, scrolled sideways.",
"additionalProperties": false
}