Ploki viide

See leht dokumenteerib iga plokitüübi, mille redaktor kaasa toob. Igal plokil on JSON-kuju, renderdaja ja programmiline lisamistee editor.blocks.insert kaudu.

Kõik plokid jagavad serialiseerimisel sama ümbrikku: id, type, data ja valikuline tunes-kirje.

Ploki kuju

Iga plokk serialiseeritakse samasse JSON-ümbrikku. id määratakse redaktori poolt ja seda saab andmete programmaatilise koostamise korral välja jätta.

{
  "id": "abc123",
  "type": "paragraph",
  "data": { "html": "Hello <b>world</b>" },
  "tunes": {}
}

alert

Esiletõstetud teatekast 4 variandiga.

{
  "type": "alert",
  "data": { "html": "Your session will expire in 5 minutes.", "variant": "warning" }
}

audio

Heliplokk. Kasutatakse Editor.create audioUploader tagasikutse kaudu.

{
  "type": "audio",
  "data": { "url": "/media/podcast.mp3", "caption": "Episode 12", "alignment": "center" }
}

checklist

Interaktiivne märkeruutude loend iga elemendi märgitud olekuga.

{
  "type": "checklist",
  "data": {
    "items": [
      { "text": "Install the package", "checked": true },
      { "text": "Mount the editor", "checked": false }
    ]
  }
}

code

Süntaksi esiletõstuga koodiplokk. Toetatud on 50 keelt, sealhulgas typescript, python, rust, go, ruby, swift ja kotlin.

{
  "type": "code",
  "data": { "code": "const x = 42;", "language": "typescript", "theme": "github-dark", "showCopy": true }
}

collapsible

Kokkuvolditav sektsioon pealkirja ja pesastatud alamplokkidega. Tundmatud alamplokitüübid säilitatakse muutmata kujul, nii et uuemad dokumendid elavad vanemates renderdajates üle.

{
  "type": "collapsible",
  "data": {
    "html": "Details",
    "open": true,
    "children": [{ "type": "paragraph", "data": { "html": "Hidden until opened." } }]
  }
}

collection

Manustab id järgi reaalajas kollektsioonivaate. Plokk salvestab ainult kollektsiooni identiteedi; kuju ja andmed kuuluvad serverile.

{
  "type": "collection",
  "data": { "collectionId": "c-42" }
}

columns

Mitmeveeruline paigutus 2 kuni 4 veeruga, millest igaüks hoiab oma alamplokkide loendit.

{
  "type": "columns",
  "data": {
    "columns": [
      [{ "type": "paragraph", "data": { "html": "Left" } }],
      [{ "type": "paragraph", "data": { "html": "Right" } }]
    ]
  }
}

date

Kalendrikuupäev, mis salvestatakse ajavööndita, nii et kõik kaastöötajad on selles ühel meelel.

{
  "type": "date",
  "data": { "date": "2026-08-31" }
}

delimiter

Visuaalne eraldaja sektsioonide vahel.

{
  "type": "delimiter",
  "data": { "variant": "line" }
}

doc_card

Rikas lingikaart teise dokumendi jaoks. See salvestab viidatud lehe id ja kuvamise hetktõmmise, mida hostid ümbernimetamisel värskendavad.

{
  "type": "doc_card",
  "data": { "pageId": "p-7", "title": "Release notes", "icon": "📄" }
}

embed

Manustatud link. Plokk salvestab URL-i; pakkuja ja manustamise märgistus tuletatakse renderdamisel, avamisväljad on varukaardiks.

{
  "type": "embed",
  "data": { "url": "https://www.youtube.com/watch?v=abc123" }
}

file

Failimanus allalaadimislingi, nime ning valikulise suuruse ja sisutüübiga.

{
  "type": "file",
  "data": { "url": "/files/notes.pdf", "name": "notes.pdf", "size": 2048, "contentType": "application/pdf" }
}

glance

Sildi ja väärtuse kokkuvõttepaneel: faktiread, mida loeb ühe pilguga, valikulise pealdise ja taustavariandiga.

{
  "type": "glance",
  "data": {
    "caption": "Facts",
    "rows": [{ "label": "Version", "html": "<b>1.0</b>" }],
    "variant": "plain"
  }
}

header

Ülataseme ja sektsiooni pealkirjad (h1 kuni h6). Tekstisisesed tööriistad töötavad html-koormuse sees.

{
  "type": "header",
  "data": { "html": "Getting started", "level": "h2" }
}

image

Pildiplokk pealdise ja alt-tekstiga. Kasutatakse Editor.create imageUploader tagasikutse kaudu.

{
  "type": "image",
  "data": { "url": "/img/hero.jpg", "caption": "Hero image", "alt": "A hero", "alignment": "center" }
}

issues

Seotud teemade tabel, mis tuletatakse renderdamisel lehe teemakiipidest ja -kaartidest (teema, pealkiri, olek, vastutaja). See ei salvesta oma andmeid.

See plokk ei salvesta ühtegi välja; read tuletatakse renderdamisel lehe teemakiipidest ja -kaartidest.

{
  "type": "issues",
  "data": {}
}

latex

LaTeX-matemaatika, salvestatakse lähtekoodina ja laotakse renderdamisel. Parem renderdaja hiljem parandab iga juba olemasolevat dokumenti.

{
  "type": "latex",
  "data": { "source": "\\frac{a}{b}" }
}

list

Järjestatud või järjestamata loend. Iga element on html.

{
  "type": "list",
  "data": { "type": "unordered", "items": ["First item", "Second item"] }
}

mermaid

Mermaid-diagramm, salvestatakse lähtekoodina ja joonistatakse kuvamisel, mitte kunagi rasterpildina.

{
  "type": "mermaid",
  "data": { "source": "flowchart TD\n  A --> B" }
}

openapi

Renderdab interaktiivse API-viite OpenAPI 3.x dokumendist, kas manustatuna või URL-ilt toodud, koos serverivalijate ja koodinäidetega.

{
  "type": "openapi",
  "data": { "url": "/api/openapi.json", "defaultServer": "https://api.example.com" }
}

paragraph

Vormindatud tekstilõik. Aktsepteerib tekstisiseste tööriistade märgistust nagu bold, italic, code, link, marker ja tooltip.

{
  "type": "paragraph",
  "data": { "html": "This is a <b>paragraph</b> with inline markup." }
}

quote

Tsitaat valikulise autori viitega.

{
  "type": "quote",
  "data": { "html": "The best way to predict the future is to invent it.", "author": "Alan Kay" }
}

sketch

Vabakäejoonistus, mis salvestatakse tõmmetena, mitte kunagi rasterpildina, nii et see jääb muudetavaks ja skaleerub puhtalt.

{
  "type": "sketch",
  "data": { "strokes": [{ "points": [0, 0, 10, 10], "color": "#ff0000", "width": 3 }] }
}

table

Andmevõrk. Esimest rida saab kasutada päisena; iga lahter on html.

{
  "type": "table",
  "data": {
    "data": [["Name", "Type"], ["html", "string"], ["variant", "AlertVariant"]],
    "caption": "AlertData fields",
    "showDownload": false
  }
}

toc

Sisukord, mis tuletatakse renderdamisel dokumendi pealkirjadest. See ei salvesta oma andmeid.

See plokk ei salvesta ühtegi välja; loend tuletatakse renderdamisel dokumendi pealkirjadest.

{
  "type": "toc",
  "data": {}
}

updates

Dokumendi reaalajas tegevusvoog. See salvestab identiteedi, mitte kunagi hetktõmmist, nii et see näitab jätkuvalt praegust tegevust.

{
  "type": "updates",
  "data": { "pageId": "p-7" }
}

video

Videoplokk. Kasutatakse Editor.create videoUploader tagasikutse kaudu.

{
  "type": "video",
  "data": { "url": "/media/demo.mp4", "caption": "Product demo", "alignment": "center" }
}