BlockLevelContainer

BlockLevelContainer:

{
  blocklevels(): BlockLevel[];
  addParagraph(index?: number): Paragraph;
  addTable(index?: number): Table;
  removeElement(index: number): BlockLevel | undefined;
  replaceText: ReplaceTextSignature;
}

Container for block-level elements (paragraphs and tables).

Remarks

BlockLevelContainer is implemented by Body and TableCell, providing methods to manage block-level content within these containers.

Examples

Adding paragraphs and tables:

const body = draft.body();
const paragraph = body.addParagraph(); // Append paragraph at end
const table = body.addTable(0);    // Insert table at start

Accessing and removing elements:

const elements = body.blocklevels();
const removed = body.removeElement(0);

Properties

replaceText

replaceText: ReplaceTextSignature

Searches and replaces text within this container. See ReplaceTextSignature.

Methods

blocklevels()

blocklevels(): BlockLevel[]

Returns all block-level elements in this container.

Returns

BlockLevel[]

---

addParagraph()

addParagraph(index?): Paragraph

Adds a new paragraph. If index is provided, inserts at that position; otherwise appends to the end.

Parameters

index?

number

Returns

Paragraph

---

addTable()

addTable(index?): Table

Adds a new table. If index is provided, inserts at that position; otherwise appends to the end.

Parameters

index?

number

Returns

Table

---

removeElement()

removeElement(index): BlockLevel | undefined

Removes the element at the specified index. Returns the removed element, or undefined if index is out of bounds.

Parameters

index

number

Returns

BlockLevel | undefined