የብሎክ ማጣቀሻ
ይህ ገጽ አርታኢው የያዘውን እያንዳንዱን የብሎክ አይነት ይመዘግባል። እያንዳንዱ ብሎክ የJSON ቅርጽ፣ renderer እና በeditor.blocks.insert በኩል የፕሮግራም ማስገቢያ መንገድ አለው።
ሁሉም ብሎኮች ሲ-ተከታታይ ሲደረጉ ተመሳሳይ ኤንቨሎፕ ይጋራሉ፦ id፣ type፣ data እና አማራጭ የtunes መዝገብ።
የብሎክ ቅርጽ
እያንዳንዱ ብሎክ ወደ ተመሳሳይ JSON ኤንቨሎፕ ይሰሪያዛል። id በeditor ይሰጣል እና ዳታን ፕሮግራሚቲካሊ ሲያዘጋጁ ሊቀር ይችላል።
{
"id": "abc123",
"type": "paragraph",
"data": { "html": "Hello <b>world</b>" },
"tunes": {}
}alert
4 ቅርጾች ያሉት የተደመቀ የማስታወቂያ ሳጥን።
| መስክ | አይነት | አስፈላጊ | መግለጫ |
|---|---|---|---|
| html | string | አዎ | የማስጠንቀቂያ መልዕክቱ HTML ይዘት። የውስጠ-መስመር መሳሪያ markup ይደገፋል። |
| variant | 'error' | 'info' | 'success' | 'warning' | አዎ | የማስጠንቀቂያው ምስላዊ ቅጥ። ከነዚህ አንዱ: error, info, success, warning። |
{
"type": "alert",
"data": { "html": "Your session will expire in 5 minutes.", "variant": "warning" }
}audio
የድምፅ ብሎክ። በEditor.create ላይ ባለው audioUploader callback በኩል ይበላል።
| መስክ | አይነት | አስፈላጊ | መግለጫ |
|---|---|---|---|
| url | string | አዎ | ለማስገባት የኦዲዮ ፋይሉ URL። |
| caption | string | አይ | ከማጫወቻው በታች የሚታይ ቀጥተኛ-ጽሑፍ መግለጫ። |
| alt | string | አይ | ለኦዲዮ ኤለመንቱ ተደራሽ መለያ። |
| alignment | 'center' | 'left' | 'right' | አይ | የዝናቡ አግዳሚ አሰላለፍ። ከነዚህ አንዱ: center, left, right። |
{
"type": "audio",
"data": { "url": "/media/podcast.mp3", "caption": "Episode 12", "alignment": "center" }
}checklist
በተናጠል ምልክት የተደረገበት ሁኔታ ያለው መስተጋብራዊ የቼክ ሳጥን ዝርዝር።
| መስክ | አይነት | አስፈላጊ | መግለጫ |
|---|---|---|---|
| items | ChecklistItem[] | አዎ | የቼክ ሊስት ንጥሎች ድርድር፣ እያንዳንዱ ጽሑፍ እና የምልክት ሁኔታ አለው። |
| items[].text | string | አዎ | የንጥሉ መለያ HTML ይዘት። |
| items[].checked | boolean | አዎ | የቼክ ሳጥኑ ምልክት ተደርጎበት አለ ወይ። |
{
"type": "checklist",
"data": {
"items": [
{ "text": "Install the package", "checked": true },
{ "text": "Mount the editor", "checked": false }
]
}
}code
የአገባብ ማድመቅ ያለው የኮድ ብሎክ። 50 ቋንቋዎች ይደገፋሉ፣ typescript፣ python፣ rust፣ go፣ ruby፣ swift እና kotlin ጨምሮ።
| መስክ | አይነት | አስፈላጊ | መግለጫ |
|---|---|---|---|
| code | string | አዎ | ለማሳየት ያለው ቀጥተኛ ኮድ ሕብረቁምፊ። |
| language | CodeLanguage | አይ | የሲንታክስ ማድመቂያ ቋንቋ። ነባሪ typescript ነው። |
| theme | CodeTheme | አይ | የአርታኢ ቀለም ጭብጥ። ነባሪ github-dark ነው። |
| showCopy | boolean | አይ | በተሰጠው ውፅዓት ውስጥ የቅዳ አዝራር አሳይ። |
| syncKey | string | አይ | ቁልፍ የሚጋሩ ብሎኮች ቋንቋን አብረው ይቀያየራሉ። |
| variants | CodeVariant[] | አይ | ባዶ ካልሆነ የትር ማሰሪያ ያሳያል እና ወሳኙ ምንጭ ይሆናል። |
{
"type": "code",
"data": { "code": "const x = 42;", "language": "typescript", "theme": "github-dark", "showCopy": true }
}collapsible
ርዕስ እና የተጎጆ ልጅ ብሎኮች ያሉት ሊታጠፍ የሚችል ክፍል። ያልታወቁ የልጅ ብሎክ አይነቶች እንዳሉ ይጠበቃሉ፣ ስለዚህ አዳዲስ ሰነዶች በአሮጌ አሳያዎች ላይ ይተርፋሉ።
| መስክ | አይነት | አስፈላጊ | መግለጫ |
|---|---|---|---|
| html | string | አዎ | የክፍሉ ርዕስ እንደ የውስጥ HTML። |
| open | boolean | አይ | ክፍሉ ተዘርግቶ ይታይ እንደሆነ። |
| children | Block[] | አይ | የተጎጆ የልጅ ብሎኮች። |
{
"type": "collapsible",
"data": {
"html": "Details",
"open": true,
"children": [{ "type": "paragraph", "data": { "html": "Hidden until opened." } }]
}
}collection
የቀጥታ የስብስብ እይታን በመታወቂያ ያካትታል። ብሎኩ የስብስቡን ማንነት ብቻ ያከማቻል፤ ቅርጹንና ውሂቡን አገልጋዩ ይይዛል።
| መስክ | አይነት | አስፈላጊ | መግለጫ |
|---|---|---|---|
| collectionId | string | አዎ | የተካተተው ስብስብ መታወቂያ። የሚከማቸው ብቸኛው ነገር። |
{
"type": "collection",
"data": { "collectionId": "c-42" }
}columns
ከ2 እስከ 4 ዓምዶች ያሉት ባለ ብዙ ዓምድ አቀማመጥ፤ እያንዳንዱ ዓምድ የራሱን የልጅ ብሎኮች ዝርዝር ይይዛል።
| መስክ | አይነት | አስፈላጊ | መግለጫ |
|---|---|---|---|
| columns | Block[][] | አዎ | ዓምዶቹ፣ እያንዳንዱ የልጅ ብሎኮች ዝርዝር። ከሁለት እስከ አራት ዓምዶች። |
{
"type": "columns",
"data": {
"columns": [
[{ "type": "paragraph", "data": { "html": "Left" } }],
[{ "type": "paragraph", "data": { "html": "Right" } }]
]
}
}date
የቀን መቁጠሪያ ቀን፣ ያለ የሰዓት ሰቅ የሚከማች ስለሆነ ሁሉም ተባባሪዎች በእሱ ላይ ይስማማሉ።
| መስክ | አይነት | አስፈላጊ | መግለጫ |
|---|---|---|---|
| date | string | አዎ | በ yyyy-MM-dd ቅርጸት ISO ቀን፣ ያለ የሰዓት ሰቅ። |
{
"type": "date",
"data": { "date": "2026-08-31" }
}delimiter
በክፍሎች መካከል ያለ የእይታ መለያያ።
| መስክ | አይነት | አስፈላጊ | መግለጫ |
|---|---|---|---|
| variant | 'line' | 'stars' | አዎ | የምክፋዩ ምስላዊ ቅጥ። ከነዚህ አንዱ: line, stars። |
{
"type": "delimiter",
"data": { "variant": "line" }
}doc_card
ለሌላ ሰነድ የበለጸገ የአገናኝ ካርድ። የተጠቀሰውን ገጽ መታወቂያ እና ስሙ ሲቀየር አስተናጋጆች የሚያድሱትን የማሳያ ቅጽበታዊ ፎቶ ያከማቻል።
| መስክ | አይነት | አስፈላጊ | መግለጫ |
|---|---|---|---|
| pageId | string | አዎ | የተጠቀሰው ገጽ መታወቂያ፤ የካርዱ ማንነት። |
| title | string | አዎ | የገጹ ርዕስ የማሳያ ቅጽበታዊ ፎቶ። |
| icon | string | አይ | በካርዱ ላይ የሚታይ አማራጭ አዶ። |
| description | string | አይ | ከርዕሱ በታች የሚታይ አማራጭ መግለጫ። |
{
"type": "doc_card",
"data": { "pageId": "p-7", "title": "Release notes", "icon": "📄" }
}embed
የተካተተ አገናኝ። ብሎኩ URL-ን ያከማቻል፤ አቅራቢውና የመክተቻ ምልክቱ በማሳያ ጊዜ ይወሰዳሉ፣ የመክፈቻ መስኮች እንደ መጠባበቂያ ካርድ ያገለግላሉ።
| መስክ | አይነት | አስፈላጊ | መግለጫ |
|---|---|---|---|
| url | string | አዎ | የተካተተው አገናኝ። አቅራቢውና የመክተቻ ምልክቱ ከእሱ በማሳያ ጊዜ ይወሰዳሉ። |
| title | string | አይ | ለአገናኝ ካርዱ የመክፈቻ ቅጽበታዊ ፎቶ። |
| description | string | አይ | ለአገናኝ ካርዱ የመክፈቻ መግለጫ። |
| imageUrl | string | አይ | ለአገናኝ ካርዱ የመክፈቻ ቅድመ-እይታ ምስል። |
| display | 'card' | አይ | ቀጥታ እይታ ቢኖርም የአገናኝ ካርድ ለማሳየት "card"። |
| file | object | አይ | የDrive ፋይል ስም፣ አይነት እና አዶ፣ ከለጣፊው Google መለያ። |
| gist | object | አይ | የgist ፋይሎች እንደተለጠፉ፣ የGitHub እይታ መጫን በማይችልበት ቦታ እንደ ኮድ ይሳላሉ። |
| reason | string | አይ | ቀጥታ እይታው ለምን እንደማይታይ: connect_google፣ no_access፣ provider_unreachable ወይም switched_off። |
| issue | object | አይ | እንደ ካርድ የሚታይ የጉዳይ አገናኝ: የመጨረሻው የተነበበ ቅጽበታዊ ገጽ (tool, key, title, stateName, category, assigneeName, updatedAt, reason)። |
{
"type": "embed",
"data": { "url": "https://www.youtube.com/watch?v=abc123" }
}file
የማውረጃ አገናኝ፣ ስም እና አማራጭ መጠንና የይዘት አይነት ያለው የፋይል አባሪ።
| መስክ | አይነት | አስፈላጊ | መግለጫ |
|---|---|---|---|
| url | string | አዎ | ፋይሉ የሚቀርብበት ቦታ። |
| name | string | አዎ | በአባሪው ላይ የሚታየው የፋይል ስም። |
| size | number | አይ | የፋይል መጠን በባይት። |
| contentType | string | አይ | የፋይሉ MIME አይነት። |
{
"type": "file",
"data": { "url": "/files/notes.pdf", "name": "notes.pdf", "size": 2048, "contentType": "application/pdf" }
}glance
የመለያና የእሴት ማጠቃለያ ፓነል፦ በአንድ እይታ የሚነበቡ የእውነታ ረድፎች፣ ከአማራጭ መግለጫ ጽሑፍና የጀርባ ልዩነት ጋር።
| መስክ | አይነት | አስፈላጊ | መግለጫ |
|---|---|---|---|
| rows | GlanceRow[] | አዎ | የሚታዩት እውነታዎች፦ እያንዳንዱ ረድፍ መለያና የውስጥ HTML እሴት ነው። |
| caption | string | አይ | ከረድፎቹ በላይ አማራጭ መግለጫ ጽሑፍ። |
| variant | 'plain' | 'error' | 'info' | 'success' | 'warning' | አይ | የጀርባ ልዩነት፤ plain ያለ ቅጥ ነው፣ ቀሪዎቹ ከማንቂያ ቤተ-ቀለም ጋር ይመሳሰላሉ። |
{
"type": "glance",
"data": {
"caption": "Facts",
"rows": [{ "label": "Version", "html": "<b>1.0</b>" }],
"variant": "plain"
}
}header
ከፍተኛ-ደረጃ እና የክፍል ርዕሶች (h1 እስከ h6)። የውስጠ-መስመር መሳሪያዎች በhtml ጭነት ውስጥ ይሰራሉ።
| መስክ | አይነት | አስፈላጊ | መግለጫ |
|---|---|---|---|
| html | string | አዎ | የርዕሱ HTML ይዘት። የውስጠ-መስመር መሳሪያ markup ይደገፋል። |
| level | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | አይ | የርዕስ ደረጃ። ከነዚህ አንዱ: h1, h2, h3, h4, h5, h6። ነባሪ h1 ነው። |
{
"type": "header",
"data": { "html": "Getting started", "level": "h2" }
}image
መግለጫ ጽሑፍ እና alt ጽሑፍ ያለው የምስል ብሎክ። በEditor.create ላይ ባለው imageUploader callback በኩል ይበላል።
| መስክ | አይነት | አስፈላጊ | መግለጫ |
|---|---|---|---|
| url | string | አዎ | ለማስገባት ያለው ምስሉ URL። |
| caption | string | አይ | ከምስሉ በታች ይታይ የሚልለው ቀጥተኛ-ጽሑፍ ርዕስ። |
| alt | string | አይ | ለምስሉ ኤለመንት የalt ጽሑፍ። |
| alignment | 'center' | 'left' | 'right' | አይ | የምስሉ አግዳሚ አሰላለፍ። ከነዚህ አንዱ: center, left, right። |
{
"type": "image",
"data": { "url": "/img/hero.jpg", "caption": "Hero image", "alt": "A hero", "alignment": "center" }
}issues
በገጹ ውስጥ ካሉ የጉዳይ ቺፖች እና ካርዶች በማሳያ ጊዜ የሚወሰድ የተገናኙ ጉዳዮች ሰንጠረዥ (ጉዳይ፣ ርዕስ፣ ሁኔታ፣ ኃላፊ)። የራሱ ውሂብ አያከማችም።
ይህ ብሎክ ምንም መስኮች አያከማችም፤ ረድፎቹ በማሳያ ጊዜ ከገጹ የጉዳይ ቺፖች እና ካርዶች ይወሰዳሉ።
{
"type": "issues",
"data": {}
}latex
የ LaTeX ሒሳብ፣ እንደ ምንጭ የሚከማች እና በማሳያ ጊዜ የሚቀናበር። ወደፊት የተሻለ አቀናባሪ ሲመጣ አስቀድሞ ያለውን እያንዳንዱን ሰነድ ያሻሽላል።
| መስክ | አይነት | አስፈላጊ | መግለጫ |
|---|---|---|---|
| source | string | አዎ | የ LaTeX ምንጩ። እንደ ምንጭ ይከማቻል፣ በጭራሽ እንደ ተቀናበረ ውጤት አይደለም። |
{
"type": "latex",
"data": { "source": "\\frac{a}{b}" }
}list
የተደረደረ ወይም ያልተደረደረ ዝርዝር። እያንዳንዱ ንጥል html ነው።
| መስክ | አይነት | አስፈላጊ | መግለጫ |
|---|---|---|---|
| type | 'ordered' | 'unordered' | አዎ | የዝርዝር አይነት። ከነዚህ አንዱ: ordered, unordered። |
| items | string[] | አዎ | የHTML ሕብረቁምፊዎች ድርድር፣ በዝርዝር ንጥል አንድ። |
{
"type": "list",
"data": { "type": "unordered", "items": ["First item", "Second item"] }
}mermaid
የ Mermaid ንድፍ፣ እንደ ምንጭ የሚከማች እና በማሳያ ጊዜ የሚሳል፣ በጭራሽ እንደ ራስተር አይደለም።
| መስክ | አይነት | አስፈላጊ | መግለጫ |
|---|---|---|---|
| source | string | አዎ | የ Mermaid ምንጩ። እንደ ምንጭ ይከማቻል፣ በጭራሽ እንደ ተሳለ ውጤት አይደለም። |
{
"type": "mermaid",
"data": { "source": "flowchart TD\n A --> B" }
}openapi
ከ OpenAPI 3.x ሰነድ በይነተገናኝ የ API ማጣቀሻ ያሳያል፣ በውስጥ የተካተተ ወይም ከ URL የሚመጣ፣ ከአገልጋይ መራጮችና የኮድ ቅንጣቢዎች ጋር።
| መስክ | አይነት | አስፈላጊ | መግለጫ |
|---|---|---|---|
| spec | object | አይ | የውስጥ OpenAPI 3.x ሰነድ። ሁለቱም ሲዘጋጁ ከ url ይቀድማል። |
| url | string | አይ | የ OpenAPI ሰነዱ በማሳያ ጊዜ ከየት እንደሚመጣ። |
| include | OpenApiFilter | አይ | የትኞቹ ክዋኔዎች እንደሚታዩ ማጣሪያ። |
| exclude | OpenApiFilter | አይ | የትኞቹ ክዋኔዎች እንደሚደበቁ ማጣሪያ። |
| defaultServer | string | አይ | ማጣቀሻው በነባሪ የሚመርጠው አገልጋይ። |
| snippetLanguages | CodeLanguage[] | አይ | ለጥያቄ ቅንጣቢዎች የሚቀርቡ ቋንቋዎች። |
{
"type": "openapi",
"data": { "url": "/api/openapi.json", "defaultServer": "https://api.example.com" }
}paragraph
የበለፀገ-ጽሑፍ አንቀጽ። እንደ bold፣ italic፣ code፣ link፣ marker እና tooltip ያሉ የውስጠ-መስመር መሳሪያ markup ይቀበላል።
| መስክ | አይነት | አስፈላጊ | መግለጫ |
|---|---|---|---|
| html | string | አዎ | የአንቀጹ HTML ይዘት። የውስጠ-መስመር መሳሪያ markup ይደገፋል። |
{
"type": "paragraph",
"data": { "html": "This is a <b>paragraph</b> with inline markup." }
}quote
አማራጭ የደራሲ መግለጫ ያለው ጥቅስ።
| መስክ | አይነት | አስፈላጊ | መግለጫ |
|---|---|---|---|
| html | string | አዎ | የጥቅሱ አካል HTML ይዘት። የውስጠ-መስመር መሳሪያ markup ይደገፋል። |
| author | string | አይ | ከጥቅሱ ስር ይታይ የሚልለው ቀጥተኛ-ጽሑፍ ወይም HTML ቅፅ። |
{
"type": "quote",
"data": { "html": "The best way to predict the future is to invent it.", "author": "Alan Kay" }
}sketch
እንደ ስትሮኮች የሚከማች የነጻ እጅ ስዕል፣ በጭራሽ ራስተር አይደለም፣ ስለዚህ ሊስተካከል የሚችል ሆኖ ይቆያል እና በንጽህና ይመዘናል።
| መስክ | አይነት | አስፈላጊ | መግለጫ |
|---|---|---|---|
| strokes | SketchStroke[] | አዎ | ስዕሉ እንደ ስትሮኮች፦ እያንዳንዱ ስትሮክ የነጥቦች ዝርዝር ከአማራጭ ቀለምና ስፋት ጋር ነው። |
{
"type": "sketch",
"data": { "strokes": [{ "points": [0, 0, 10, 10], "color": "#ff0000", "width": 3 }] }
}table
የውሂብ ፍርግርግ። የመጀመሪያው ረድፍ እንደ ራስጌ ሊውል ይችላል፤ እያንዳንዱ ሕዋስ html ነው።
| መስክ | አይነት | አስፈላጊ | መግለጫ |
|---|---|---|---|
| data | string[][] | አዎ | ሁለት-አቅጣጫዊ የHTML ሕዋስ ሕብረቁምፊዎች ድርድር። የመጀመሪያው ረድፍ ርዕስ ረድፍ ነው። |
| caption | string | አይ | ከጠረጴዛ ስር ይታይ የሚልለው ቀጥተኛ-ጽሑፍ ወይም HTML ርዕስ። |
| showDownload | boolean | አይ | በተሰጠው ውፅዓት ውስጥ የወርድ አዝራር አሳይ። |
{
"type": "table",
"data": {
"data": [["Name", "Type"], ["html", "string"], ["variant", "AlertVariant"]],
"caption": "AlertData fields",
"showDownload": false
}
}toc
በማሳያ ጊዜ ከሰነዱ ራስጌዎች የሚወሰድ ማውጫ። የራሱ ውሂብ አያከማችም።
ይህ ብሎክ ምንም መስኮች አያከማችም፤ ዝርዝሩ በማሳያ ጊዜ ከሰነዱ ራስጌዎች ይወሰዳል።
{
"type": "toc",
"data": {}
}updates
ለሰነድ የቀጥታ የእንቅስቃሴ ምግብ። ማንነትን ያከማቻል፣ በጭራሽ ቅጽበታዊ ፎቶ አይደለም፣ ስለዚህ ወቅታዊ እንቅስቃሴን ማሳየቱን ይቀጥላል።
| መስክ | አይነት | አስፈላጊ | መግለጫ |
|---|---|---|---|
| pageId | string | አይ | የየትኛው ሰነድ እንቅስቃሴ እንደሚታይ። አለመኖሩ ብሎኩ የሚገኝበትን ሰነድ ማለት ነው። |
{
"type": "updates",
"data": { "pageId": "p-7" }
}video
የቪዲዮ ብሎክ። በEditor.create ላይ ባለው videoUploader callback በኩል ይበላል።
| መስክ | አይነት | አስፈላጊ | መግለጫ |
|---|---|---|---|
| url | string | አዎ | የቪዲዮ ፋይሉ ወይም YouTube/Vimeo embed link URL። |
| caption | string | አይ | ከማጫወቻው በታች የሚታይ ቀጥተኛ-ጽሑፍ መግለጫ። |
| alt | string | አይ | ለቪዲዮ ኤለመንቱ ተደራሽ መለያ። |
| alignment | 'center' | 'left' | 'right' | አይ | የዝናቡ አግዳሚ አሰላለፍ። ከነዚህ አንዱ: center, left, right። |
{
"type": "video",
"data": { "url": "/media/demo.mp4", "caption": "Product demo", "alignment": "center" }
}