Skip to main content

Class: MarkNode

@lexical/mark.MarkNode

Hierarchy

Constructors

constructor

new MarkNode(ids, key?)

Parameters

NameType
idsstring[]
key?string

Overrides

ElementNode.constructor

Defined in

packages/lexical-mark/src/MarkNode.ts:66

Methods

addID

addID(id): void

Parameters

NameType
idstring

Returns

void

Defined in

packages/lexical-mark/src/MarkNode.ts:118


canBeEmpty

canBeEmpty(): false

Returns

false

Overrides

ElementNode.canBeEmpty

Defined in

packages/lexical-mark/src/MarkNode.ts:164


canInsertTextAfter

canInsertTextAfter(): false

Returns

false

Overrides

ElementNode.canInsertTextAfter

Defined in

packages/lexical-mark/src/MarkNode.ts:160


canInsertTextBefore

canInsertTextBefore(): false

Returns

false

Overrides

ElementNode.canInsertTextBefore

Defined in

packages/lexical-mark/src/MarkNode.ts:156


createDOM

createDOM(config): HTMLElement

Parameters

NameType
configEditorConfig

Returns

HTMLElement

Overrides

ElementNode.createDOM

Defined in

packages/lexical-mark/src/MarkNode.ts:71


deleteID

deleteID(id): void

Parameters

NameType
idstring

Returns

void

Defined in

packages/lexical-mark/src/MarkNode.ts:133


excludeFromCopy

excludeFromCopy(destination): boolean

Parameters

NameType
destination"clone" | "html"

Returns

boolean

Overrides

ElementNode.excludeFromCopy

Defined in

packages/lexical-mark/src/MarkNode.ts:195


exportJSON

exportJSON(): SerializedMarkNode

Controls how the this node is serialized to JSON. This is important for copy and paste between Lexical editors sharing the same namespace. It's also important if you're serializing to JSON for persistent storage somewhere. See Serialization & Deserialization.

Returns

SerializedMarkNode

Overrides

ElementNode.exportJSON

Defined in

packages/lexical-mark/src/MarkNode.ts:57


extractWithChild

extractWithChild(child, selection, destination): boolean

Parameters

NameType
childLexicalNode
selectionBaseSelection
destination"clone" | "html"

Returns

boolean

Overrides

ElementNode.extractWithChild

Defined in

packages/lexical-mark/src/MarkNode.ts:172


getIDs

getIDs(): string[]

Returns

string[]

Defined in

packages/lexical-mark/src/MarkNode.ts:113


hasID

hasID(id): boolean

Parameters

NameType
idstring

Returns

boolean

Defined in

packages/lexical-mark/src/MarkNode.ts:103


insertNewAfter

insertNewAfter(selection, restoreSelection?): null | ElementNode

Parameters

NameTypeDefault value
selectionRangeSelectionundefined
restoreSelectionbooleantrue

Returns

null | ElementNode

Overrides

ElementNode.insertNewAfter

Defined in

packages/lexical-mark/src/MarkNode.ts:147


isInline

isInline(): true

Returns

true

Overrides

ElementNode.isInline

Defined in

packages/lexical-mark/src/MarkNode.ts:168


updateDOM

updateDOM(prevNode, element, config): boolean

Parameters

NameType
prevNodeMarkNode
elementHTMLElement
configEditorConfig

Returns

boolean

Overrides

ElementNode.updateDOM

Defined in

packages/lexical-mark/src/MarkNode.ts:80


clone

Static clone(node): MarkNode

Parameters

NameType
nodeMarkNode

Returns

MarkNode

Overrides

ElementNode.clone

Defined in

packages/lexical-mark/src/MarkNode.ts:41


getType

Static getType(): string

Returns

string

Overrides

ElementNode.getType

Defined in

packages/lexical-mark/src/MarkNode.ts:37


importDOM

Static importDOM(): null

Returns

null

Overrides

ElementNode.importDOM

Defined in

packages/lexical-mark/src/MarkNode.ts:45


importJSON

Static importJSON(serializedNode): MarkNode

Parameters

NameType
serializedNodeSerializedMarkNode

Returns

MarkNode

Overrides

ElementNode.importJSON

Defined in

packages/lexical-mark/src/MarkNode.ts:49