Class JoinNodesStep

Join the textblock at path with its next sibling, absorbing the sibling's inline content. joinOffset must equal the first block's inline length. It makes position mapping document-independent.

Hierarchy (View Summary)

Step
- JoinNodesStep

Index

Constructors

Properties

joinOffset path

Methods

apply invert mapPosition toJSON

Constructors

constructor

new JoinNodesStep(path: Path, joinOffset: number): JoinNodesStep
Parameters
- path: Path
- joinOffset: number
Returns JoinNodesStep
Overrides Step.constructor
- Defined in packages/core/src/state/steps/split-join.ts:103

Properties

`Readonly`joinOffset

joinOffset: number

`Readonly`path

path: Path

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/split-join.ts:111

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/split-join.ts:132

mapPosition

mapPosition(position: Position): Position
Remap a pre-step position to its post-step equivalent.
Parameters
- position: Position
Returns Position
Overrides Step.mapPosition
- Defined in packages/core/src/state/steps/split-join.ts:141

toJSON

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