state/com.monkopedia.kodemirror.state/TransactionSpec

TransactionSpec

data class TransactionSpec(val changes: ChangeSpec? = null, val selection: SelectionSpec? = null, val effects: List<StateEffect<*>>? = null, val annotations: List<Annotation<*>>? = null, val userEvent: String? = null, val scrollIntoView: Boolean = false, val filter: Boolean? = null, val sequential: Boolean = false)

Describes a Transaction when calling EditorState.update.

Constructors

TransactionSpec

constructor(changes: ChangeSpec? = null, selection: SelectionSpec? = null, effects: List<StateEffect<*>>? = null, annotations: List<Annotation<*>>? = null, userEvent: String? = null, scrollIntoView: Boolean = false, filter: Boolean? = null, sequential: Boolean = false)

Properties

annotations

val annotations: List<Annotation<*>>?

Set annotations for this transaction.

changes

val changes: ChangeSpec?

The changes to the document made by this transaction.

effects

val effects: List<StateEffect<*>>?

Attach state effects to this transaction.

filter

val filter: Boolean?

By default, transactions can be modified by filters. You can set this to false to disable that.

scrollIntoView

val scrollIntoView: Boolean

When set to true, the transaction is marked as needing to scroll the current selection into view.

selection

val selection: SelectionSpec?

When set, this transaction explicitly updates the selection.

sequential

val sequential: Boolean

Normally, positions in changes refer to the initial document. When sequential is true, positions refer to the document created by the specs before it instead.

userEvent

val userEvent: String?

Shorthand for Transaction.userEvent annotation.