Transaction

An editor state transaction, which can be applied to a state to create an updated state. Use EditorState.tr to create an instance.

Transactions track changes to the document (they are a subclass of Transform), but also other state changes, like selection updates and adjustments of the set of stored marks. In addition, you can store metadata properties in a transaction, which are extra pieces of information that client code or plugins can use to describe what a transaction represents, so that they can update their own state accordingly.

The editor view uses a few metadata properties: it will attach a property "pointer" with the value true to selection transactions directly caused by mouse or touch input, a "composition" property holding an ID identifying the composition that caused it to transactions caused by composed DOM input, and a "uiEvent" property of that may be "paste", "cut", or "drop".

class Transaction extends Transform {

private curSelection;

private curSelectionFor;

private meta;

private updated;

get selection(): Selection;

get selectionSet(): boolean;

storedMarks: readonly Mark[] | null;

get storedMarksSet(): boolean;

get isGeneric(): boolean;

get scrolledIntoView(): boolean;

time: number;

addStoredMark(mark: Mark): this;

deleteSelection(): this;

ensureMarks(marks: readonly Mark[]): this;

getMeta(key: string | Plugin | PluginKey): any;

insertText(

text: string,

from?: number,

to?: number,

): this;

removeStoredMark(mark: Mark | MarkType): this;

replaceSelection(slice: Slice): this;

replaceSelectionWith(node: Node, inheritMarks?: boolean): this;

scrollIntoView(): this;

setMeta(key: string | Plugin | PluginKey, value: any): this;

setSelection(selection: Selection): this;

setStoredMarks(marks: readonly Mark[] | null): this;

setTime(time: number): this;

}

§Extends

Transform

Transaction

§Extends

§Properties

§Methods