@sqlrooms/documents / createBlockDocumentTextBlock

Function: createBlockDocumentTextBlock()

createBlockDocumentTextBlock(params): { id: string; intent?: string; type: "heading"; level: 1 | 2 | 3; text: BlockDocumentNode[]; } | { id: string; intent?: string; type: "paragraph"; text: BlockDocumentNode[]; } | { id: string; intent?: string; type: "list"; ordered?: boolean; items: BlockDocumentNode[][]; } | { id: string; intent?: string; type: "todo"; checked: boolean; text: BlockDocumentNode[]; } | { id: string; intent?: string; type: "image"; assetId: string; caption?: string; } | { id: string; intent?: string; type: "chartImage"; assetId: string; caption?: string; } | { id: string; intent?: string; type: "chart"; tableName: string; config: unknown; selectionGroupId?: string; caption?: string; } | { id: string; intent?: string; type: "statefulBlock"; blockType: string; blockInstanceId: string; ownership?: "owned" | "shared" | "external"; caption?: string; tableName?: string; height?: number; }

Creates a heading, paragraph, or list block with a unique block ID.

Parameters

Parameter	Type
params	{ type: "heading" | "paragraph" | "list"; text?: object[]; level: 1 | 2 | 3; items?: object[][]; ordered: boolean; reasoning: string; }
params.type	"heading" | "paragraph" | "list"
params.text?	object[]
params.level	1 | 2 | 3
params.items?	object[][]
params.ordered	boolean
params.reasoning	string

Returns

Type Literal

{ id: string; intent?: string; type: "heading"; level: 1 | 2 | 3; text: BlockDocumentNode[]; }

---

Type Literal

{ id: string; intent?: string; type: "paragraph"; text: BlockDocumentNode[]; }

---

Type Literal

{ id: string; intent?: string; type: "list"; ordered?: boolean; items: BlockDocumentNode[][]; }

---

Type Literal

{ id: string; intent?: string; type: "todo"; checked: boolean; text: BlockDocumentNode[]; }

---

Type Literal

{ id: string; intent?: string; type: "image"; assetId: string; caption?: string; }

---

Type Literal

{ id: string; intent?: string; type: "chartImage"; assetId: string; caption?: string; }

---

Type Literal

{ id: string; intent?: string; type: "chart"; tableName: string; config: unknown; selectionGroupId?: string; caption?: string; }

---

Type Literal

{ id: string; intent?: string; type: "statefulBlock"; blockType: string; blockInstanceId: string; ownership?: "owned" | "shared" | "external"; caption?: string; tableName?: string; height?: number; }

Name	Type	Description
id	string	-
intent?	string	-
type	"statefulBlock"	-
blockType	string	-
blockInstanceId	string	-
ownership?	"owned" | "shared" | "external"	-
caption?	string	User-facing label shown for the block in the document flow.
tableName?	string	Table identity this block reads from, for block types that bind to a single table (currently data-table). Resolved via db.findTable, same as the chart block's tableName. Other block types leave this unset and keep their data binding inside their own backing state.
height?	number	-