Skip to content

youtube

A YouTube video.

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="youtube" 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 "youtube" Yes The block’s type.
url string Yes The video’s YouTube URL.
startTime number No Where it starts playing, in seconds.
caption string No A caption under it.
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": "youtube",
      "description": "The block's type."
    },
    "url": {
      "type": "string",
      "description": "The video's YouTube URL."
    },
    "startTime": {
      "type": "number",
      "description": "Where it starts playing, in seconds."
    },
    "caption": {
      "type": "string",
      "description": "A caption under it."
    },
    "hidden": {
      "type": "boolean",
      "description": "Whether the block is hidden: it, and every block it holds, doesn't show."
    }
  },
  "required": [
    "id",
    "type",
    "url"
  ],
  "description": "A YouTube video.",
  "additionalProperties": false
}

Type to search…

↑↓ navigate↵ selectEsc close