Skip to content

side-by-side

Two columns of blocks side by side.

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="side-by-side" 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 "side-by-side" 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.
left array of block No The blocks of the left column.
right array of block No The blocks of the right column.
alignment "start" or "center" or "end" No Kept, but not shown.
horizontalAlignment "start" or "center" or "end" No How the two columns align vertically: start, center (the default) or end.
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": "side-by-side",
      "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."
    },
    "left": {
      "type": "array",
      "items": {
        "$ref": "https://docs.sherpo.io/overview/blocks/schema.json"
      },
      "description": "The blocks of the left column."
    },
    "right": {
      "type": "array",
      "items": {
        "$ref": "https://docs.sherpo.io/overview/blocks/schema.json"
      },
      "description": "The blocks of the right column."
    },
    "alignment": {
      "type": "string",
      "enum": [
        "start",
        "center",
        "end"
      ],
      "description": "Kept, but not shown."
    },
    "horizontalAlignment": {
      "type": "string",
      "enum": [
        "start",
        "center",
        "end"
      ],
      "description": "How the two columns align vertically: `start`, `center` (the default) or `end`."
    },
    "hidden": {
      "type": "boolean",
      "description": "Whether the block is hidden: it, and every block it holds, doesn't show."
    }
  },
  "required": [
    "id",
    "type"
  ],
  "description": "Two columns of blocks side by side.",
  "additionalProperties": false
}

Type to search…

↑↓ navigate↵ selectEsc close