Skip to main content

Class: LinkNode

@lexical/link.LinkNode

Hierarchy

Constructors

constructor

new LinkNode(url, attributes?, key?)

Parameters

NameType
urlstring
attributesLinkAttributes
key?string

Overrides

ElementNode.constructor

Defined in

lexical-link/src/index.ts:78

Methods

canBeEmpty

canBeEmpty(): false

Returns

false

Overrides

ElementNode.canBeEmpty

Defined in

lexical-link/src/index.ts:254


canInsertTextAfter

canInsertTextAfter(): false

Returns

false

Overrides

ElementNode.canInsertTextAfter

Defined in

lexical-link/src/index.ts:250


canInsertTextBefore

canInsertTextBefore(): false

Returns

false

Overrides

ElementNode.canInsertTextBefore

Defined in

lexical-link/src/index.ts:246


createDOM

createDOM(config): HTMLAnchorElement

Parameters

NameType
configEditorConfig

Returns

HTMLAnchorElement

Overrides

ElementNode.createDOM

Defined in

lexical-link/src/index.ts:87


exportJSON

exportJSON(): SerializedLinkNode

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

SerializedLinkNode

Overrides

ElementNode.exportJSON

Defined in

lexical-link/src/index.ts:178


extractWithChild

extractWithChild(child, selection, destination): boolean

Parameters

NameType
childLexicalNode
selectionRangeSelection | NodeSelection | GridSelection
destination"clone" | "html"

Returns

boolean

Overrides

ElementNode.extractWithChild

Defined in

lexical-link/src/index.ts:262


getRel

getRel(): null | string

Returns

null | string

Defined in

lexical-link/src/index.ts:208


getTarget

getTarget(): null | string

Returns

null | string

Defined in

lexical-link/src/index.ts:199


getTitle

getTitle(): null | string

Returns

null | string

Defined in

lexical-link/src/index.ts:217


getURL

getURL(): string

Returns

string

Defined in

lexical-link/src/index.ts:190


insertNewAfter

insertNewAfter(selection, restoreSelection?): null | ElementNode

Parameters

NameTypeDefault value
selectionRangeSelectionundefined
restoreSelectionbooleantrue

Returns

null | ElementNode

Overrides

ElementNode.insertNewAfter

Defined in

lexical-link/src/index.ts:226


isInline

isInline(): true

Returns

true

Overrides

ElementNode.isInline

Defined in

lexical-link/src/index.ts:258


sanitizeUrl

sanitizeUrl(url): string

Parameters

NameType
urlstring

Returns

string

Defined in

lexical-link/src/index.ts:165


setRel

setRel(rel): void

Parameters

NameType
relnull | string

Returns

void

Defined in

lexical-link/src/index.ts:212


setTarget

setTarget(target): void

Parameters

NameType
targetnull | string

Returns

void

Defined in

lexical-link/src/index.ts:203


setTitle

setTitle(title): void

Parameters

NameType
titlenull | string

Returns

void

Defined in

lexical-link/src/index.ts:221


setURL

setURL(url): void

Parameters

NameType
urlstring

Returns

void

Defined in

lexical-link/src/index.ts:194


updateDOM

updateDOM(prevNode, anchor, config): boolean

Parameters

NameType
prevNodeLinkNode
anchorHTMLAnchorElement
configEditorConfig

Returns

boolean

Overrides

ElementNode.updateDOM

Defined in

lexical-link/src/index.ts:103


clone

Static clone(node): LinkNode

Parameters

NameType
nodeLinkNode

Returns

LinkNode

Overrides

ElementNode.clone

Defined in

lexical-link/src/index.ts:70


getType

Static getType(): string

Returns

string

Overrides

ElementNode.getType

Defined in

lexical-link/src/index.ts:66


importDOM

Static importDOM(): null | DOMConversionMap

Returns

null | DOMConversionMap

Defined in

lexical-link/src/index.ts:142


importJSON

Static importJSON(serializedNode): LinkNode

Parameters

NameType
serializedNodeSerializedLinkNode

Returns

LinkNode

Overrides

ElementNode.importJSON

Defined in

lexical-link/src/index.ts:151