Class AddMarkStep

Add a mark across an inline range.

Hierarchy

MarkStep
- AddMarkStep

Index

Constructors

Properties

blockPath from mark to

Methods

apply applyMark invert mapPosition toJSON

Constructors

constructor

new AddMarkStep(
    blockPath: Path,
    from: number,
    to: number,
    mark: Mark,
): AddMarkStep
Parameters
- blockPath: Path
- from: number
- to: number
- mark: Mark
Returns AddMarkStep
Inherited from MarkStep.constructor
- Defined in packages/core/src/state/steps/mark-steps.ts:9

Properties

`Readonly`blockPath

blockPath: Path

`Readonly`from

from: number

`Readonly`mark

mark: Mark

`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 MarkStep.apply
- Defined in packages/core/src/state/steps/mark-steps.ts:42

`Protected`applyMark

applyMark(doc: EditorNode, add: boolean, name: string): StepResult
Parameters
- doc: EditorNode
- add: boolean
- name: string
Returns StepResult
Inherited from MarkStep.applyMark
- Defined in packages/core/src/state/steps/mark-steps.ts:19

invert

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

Returns Step
Overrides MarkStep.invert
- Defined in packages/core/src/state/steps/mark-steps.ts:46

mapPosition

mapPosition(position: Position): Position
Mark steps never move content.
Parameters
- position: Position
Returns Position
Inherited from MarkStep.mapPosition
- Defined in packages/core/src/state/steps/mark-steps.ts:35

toJSON

toJSON(): Record<string, unknown>
Returns Record<string, unknown>
Overrides MarkStep.toJSON
- Defined in packages/core/src/state/steps/mark-steps.ts:50