Class ReplaceNodesStep

Replace the children [from, to) of the element node at parentPath with a fragment. Covers node insertion (from === to) and removal (empty fragment).

Hierarchy (View Summary)

Step
- ReplaceNodesStep

Index

Constructors

Properties

from insert parentPath to

Methods

apply invert mapPosition toJSON

Constructors

constructor

new ReplaceNodesStep(
    parentPath: Path,
    from: number,
    to: number,
    insert: Fragment,
): ReplaceNodesStep
Parameters
- parentPath: Path
- from: number
- to: number
- insert: Fragment
Returns ReplaceNodesStep
Overrides Step.constructor
- Defined in packages/core/src/state/steps/replace-nodes.ts:12

Properties

`Readonly`from

from: number

`Readonly`insert

insert: Fragment

`Readonly`parentPath

parentPath: Path

`Readonly`to

to: number

Methods

apply

apply(doc: EditorNode): StepResult
Apply to a document. Never throws, returns a failure result instead.
Parameters
- doc: EditorNode
Returns StepResult
Overrides Step.apply
- Defined in packages/core/src/state/steps/replace-nodes.ts:22

invert

invert(docBefore: EditorNode): Step
Produce the step that undoes this one, given the document it applied to.
Parameters
- docBefore: EditorNode
Returns Step
Overrides Step.invert
- Defined in packages/core/src/state/steps/replace-nodes.ts:36

mapPosition

mapPosition(position: Position, bias?: Bias): Position
Remap a pre-step position to its post-step equivalent.
Parameters
- position: Position
- bias: Bias = 1
Returns Position
Overrides Step.mapPosition
- Defined in packages/core/src/state/steps/replace-nodes.ts:48

toJSON

toJSON(): Record<string, unknown>
Returns Record<string, unknown>
Overrides Step.toJSON
- Defined in packages/core/src/state/steps/replace-nodes.ts:75