app.offprint.block.webEmbed Documentation (EN)

main object

No description available.

Properties

alignment string Optional

Horizontal alignment

description string Optional

Page description/excerpt

maxGraphemes: 1000 graphemes

embedHeight integer Optional

Native embed height in pixels

minimum: 1

embedUrl string uri Optional

oEmbed URL for iframe embedding

embedWidth integer Optional

Native embed width in pixels

minimum: 1

href string uri Required

The URL of the embedded page

preview blob Optional

Screenshot of the embedded content (1280×720px)

maxSize: 1.0 MB

siteName string Optional

Name of the website

maxGraphemes: 100 graphemes

title string Optional

Page title

maxGraphemes: 300 graphemes

width string Optional

CSS width value (e.g., "100%", "75%". "50%" minimum)

View raw schema

{
  "type": "object",
  "required": [
    "href"
  ],
  "properties": {
    "href": {
      "type": "string",
      "format": "uri",
      "required": true,
      "description": "The URL of the embedded page"
    },
    "title": {
      "type": "string",
      "description": "Page title",
      "maxGraphemes": 300
    },
    "width": {
      "type": "string",
      "description": "CSS width value (e.g., \"100%\", \"75%\". \"50%\" minimum)"
    },
    "preview": {
      "type": "blob",
      "accept": [
        "image/*"
      ],
      "maxSize": 1000000,
      "description": "Screenshot of the embedded content (1280×720px)"
    },
    "embedUrl": {
      "type": "string",
      "format": "uri",
      "description": "oEmbed URL for iframe embedding"
    },
    "siteName": {
      "type": "string",
      "description": "Name of the website",
      "maxGraphemes": 100
    },
    "alignment": {
      "enum": [
        "left",
        "center",
        "right"
      ],
      "type": "string",
      "description": "Horizontal alignment"
    },
    "embedWidth": {
      "type": "integer",
      "minimum": 1,
      "description": "Native embed width in pixels"
    },
    "description": {
      "type": "string",
      "description": "Page description/excerpt",
      "maxGraphemes": 1000
    },
    "embedHeight": {
      "type": "integer",
      "minimum": 1,
      "description": "Native embed height in pixels"
    }
  }
}