Skip to content

expandable

Blocks shown up to a set height, with a button to show the rest.

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="expandable" 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 "expandable" Yes The block’s type.
title string No Kept, but not shown.
defaultExpanded boolean No Whether it starts showing all of its blocks. Defaults to false.
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": "expandable",
      "description": "The block's type."
    },
    "title": {
      "type": "string",
      "description": "Kept, but not shown."
    },
    "defaultExpanded": {
      "default": false,
      "type": "boolean",
      "description": "Whether it starts showing all of its blocks."
    },
    "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": "Blocks shown up to a set height, with a button to show the rest.",
  "additionalProperties": false
}

Type to search…

↑↓ navigate↵ selectEsc close