Transaction

tested

A mutable builder that accumulates atomic {@link Step}s over a working copy of the document. Each builder method applies its step immediately (so later builders see prior effects) and records the exact inverse for undo. Dispatch turns the finished transaction into a new {@link EditorState}.

Source Tests

Signature

class Transaction

Properties

Property	Type	Default	Description
`before`readonly	`EditorState`	—	—
`steps`readonly	`Step[]`	—	—
`inverted`readonly	`Step[]`	—	Inverse of each step, in application order (reversed when undoing).
`meta`readonly	`Map<string, unknown>`	—	—
`doc`	`EditorDocument`	—	Working document after the steps applied so far.
`selection`	`Selection`	—	Selection to apply after this transaction.
`storedMarks`	`Marks \| null \| undefined`	—	`undefined` = leave stored marks to default handling; otherwise set them.
`lastSplitId`	`string \| undefined`	—	Id of the block created by the most recent {@link splitBlock}.

Methods

step

Apply a raw step (also used by undo/redo to replay stored steps).

step(step: Step): this

Parameter	Type	Default	Description
`step`	`Step`	—	—

Returnsthis

insertText

insertText(pos: Position, text: string, marks: Marks = []): this

Parameter	Type	Default	Description
`pos`	`Position`	—	—
`text`	`string`	—	—
`marks`?	`Marks`	`[]`	—

Returnsthis

insertInline

insertInline(pos: Position, content: Inline): this

Parameter	Type	Default	Description
`pos`	`Position`	—	—
`content`	`Inline`	—	—

Returnsthis

deleteText

deleteText(blockId: string, from: number, to: number): this

Parameter	Type	Default	Description
`blockId`	`string`	—	—
`from`	`number`	—	—
`to`	`number`	—	—

Returnsthis

replaceInline

replaceInline(blockId: string, from: number, to: number, content: Inline): this

Parameter	Type	Default	Description
`blockId`	`string`	—	—
`from`	`number`	—	—
`to`	`number`	—	—
`content`	`Inline`	—	—

Returnsthis

setBlockContent

Replace a block's entire inline content (used by the input flush path).

setBlockContent(blockId: string, content: Inline): this

Parameter	Type	Default	Description
`blockId`	`string`	—	—
`content`	`Inline`	—	—

Returnsthis

addMark

addMark(blockId: string, from: number, to: number, mark: Mark): this

Parameter	Type	Default	Description
`blockId`	`string`	—	—
`from`	`number`	—	—
`to`	`number`	—	—
`mark`	`Mark`	—	—

Returnsthis

removeMark

removeMark(blockId: string, from: number, to: number, mark: Mark): this

Parameter	Type	Default	Description
`blockId`	`string`	—	—
`from`	`number`	—	—
`to`	`number`	—	—
`mark`	`Mark`	—	—

Returnsthis

setAttrs

Merge `attrs` into the block's existing attrs.

setAttrs(blockId: string, attrs: Attrs): this

Parameter	Type	Default	Description
`blockId`	`string`	—	—
`attrs`	`Readonly<Record<string, import("..").AttrValue>>`	—	—

Returnsthis

setBlockType

Convert a block to another type, preserving its inline content.

setBlockType(blockId: string, type: string, attrs?: Attrs): this

Parameter	Type	Default	Description
`blockId`	`string`	—	—
`type`	`string`	—	—
`attrs`?	`Readonly<Record<string, import("..").AttrValue>> \| undefined`	—	—

Returnsthis

splitBlock

splitBlock(pos: Position, newType?: string, newAttrs?: Attrs, newId: string = createId()): this

Parameter	Type	Default	Description
`pos`	`Position`	—	—
`newType`?	`string \| undefined`	—	—
`newAttrs`?	`Readonly<Record<string, import("..").AttrValue>> \| undefined`	—	—
`newId`?	`string`	`createId()`	—

Returnsthis

mergeBlock

mergeBlock(blockId: string, intoId: string): this

Parameter	Type	Default	Description
`blockId`	`string`	—	—
`intoId`	`string`	—	—

Returnsthis

insertBlock

insertBlock(node: Node, index: number): this

Parameter	Type	Default	Description
`node`	`Node`	—	—
`index`	`number`	—	—

Returnsthis

removeBlock

removeBlock(blockId: string): this

Parameter	Type	Default	Description
`blockId`	`string`	—	—

Returnsthis

moveBlock

moveBlock(blockId: string, toIndex: number): this

Parameter	Type	Default	Description
`blockId`	`string`	—	—
`toIndex`	`number`	—	—

Returnsthis

setDoc

Replace the whole document (used to apply a remote CRDT snapshot).

setDoc(doc: EditorDocument): this

Parameter	Type	Default	Description
`doc`	`EditorDocument`	—	—

Returnsthis

setSelection

setSelection(selection: Selection): this

Parameter	Type	Default	Description
`selection`	`Selection`	—	—

Returnsthis

setStoredMarks

setStoredMarks(marks: Marks | null): this

Parameter	Type	Default	Description
`marks`	`Marks \| null`	—	—

Returnsthis

setMeta

setMeta(key: string, value: unknown): this

Parameter	Type	Default	Description
`key`	`string`	—	—
`value`	`unknown`	—	—

Returnsthis

getMeta

getMeta(key: string): unknown

Parameter	Type	Default	Description
`key`	`string`	—	—

Returnsunknown