Class WrapNodesStep

Wrap the children [from, to) of the node at parentPath in a new node of type wrapperType, placed at index from.

Hierarchy (View Summary)

Step
- WrapNodesStep

Index

Constructors

Properties

from parentPath to wrapperAttrs? wrapperType

Methods

apply invert mapPosition toJSON

Constructors

constructor

new WrapNodesStep(
    parentPath: Path,
    from: number,
    to: number,
    wrapperType: string,
    wrapperAttrs?: Readonly<Record<string, unknown>>,
): WrapNodesStep
Parameters
- parentPath: Path
- from: number
- to: number
- wrapperType: string
- OptionalwrapperAttrs: Readonly<Record<string, unknown>>
Returns WrapNodesStep
Overrides Step.constructor
- Defined in packages/core/src/state/steps/wrap-lift.ts:13

Properties

`Readonly`from

from: number

`Readonly`parentPath

parentPath: Path

`Readonly`to

to: number

`Optional` `Readonly`wrapperAttrs

wrapperAttrs?: Readonly<Record<string, unknown>>

`Readonly`wrapperType

wrapperType: string

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/wrap-lift.ts:24

invert

invert(): Step
Produce the step that undoes this one, given the document it applied to.

Returns Step
Overrides Step.invert
- Defined in packages/core/src/state/steps/wrap-lift.ts:41

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/wrap-lift.ts:45

toJSON

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