Skip to main content

Class: LinkNode

@lexical/link.LinkNode

Hierarchy

Constructors

constructor

new LinkNode(url, attributes?, key?): LinkNode

Parameters

NameType
urlstring
attributesLinkAttributes
key?string

Returns

LinkNode

Overrides

ElementNode.constructor

Defined in

packages/lexical-link/src/index.ts:86

Methods

canBeEmpty

canBeEmpty(): false

Returns

false

Overrides

ElementNode.canBeEmpty

Defined in

packages/lexical-link/src/index.ts:257


canInsertTextAfter

canInsertTextAfter(): false

Returns

false

Overrides

ElementNode.canInsertTextAfter

Defined in

packages/lexical-link/src/index.ts:253


canInsertTextBefore

canInsertTextBefore(): false

Returns

false

Overrides

ElementNode.canInsertTextBefore

Defined in

packages/lexical-link/src/index.ts:249


createDOM

createDOM(config): LinkHTMLElementType

Called during the reconciliation process to determine which nodes to insert into the DOM for this Lexical Node.

This method must return exactly one HTMLElement. Nested elements are not supported.

Do not attempt to update the Lexical EditorState during this phase of the update lifecyle.

Parameters

NameTypeDescription
configEditorConfigallows access to things like the EditorTheme (to apply classes) during reconciliation.

Returns

LinkHTMLElementType

Overrides

ElementNode.createDOM

Defined in

packages/lexical-link/src/index.ts:95


exportJSON

exportJSON(): SerializedLinkNode | SerializedAutoLinkNode

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 | SerializedAutoLinkNode

Overrides

ElementNode.exportJSON

Defined in

packages/lexical-link/src/index.ts:188


extractWithChild

extractWithChild(child, selection, destination): boolean

Parameters

NameType
childLexicalNode
selectionBaseSelection
destination"clone" | "html"

Returns

boolean

Overrides

ElementNode.extractWithChild

Defined in

packages/lexical-link/src/index.ts:265


getRel

getRel(): null | string

Returns

null | string

Defined in

packages/lexical-link/src/index.ts:218


getTarget

getTarget(): null | string

Returns

null | string

Defined in

packages/lexical-link/src/index.ts:209


getTitle

getTitle(): null | string

Returns

null | string

Defined in

packages/lexical-link/src/index.ts:227


getURL

getURL(): string

Returns

string

Defined in

packages/lexical-link/src/index.ts:200


insertNewAfter

insertNewAfter(_, restoreSelection?): null | ElementNode

Parameters

NameTypeDefault value
_RangeSelectionundefined
restoreSelectionbooleantrue

Returns

null | ElementNode

Overrides

ElementNode.insertNewAfter

Defined in

packages/lexical-link/src/index.ts:236


isEmailURI

isEmailURI(): boolean

Returns

boolean

Defined in

packages/lexical-link/src/index.ts:284


isInline

isInline(): true

Returns

true

Overrides

ElementNode.isInline

Defined in

packages/lexical-link/src/index.ts:261


isWebSiteURI

isWebSiteURI(): boolean

Returns

boolean

Defined in

packages/lexical-link/src/index.ts:288


sanitizeUrl

sanitizeUrl(url): string

Parameters

NameType
urlstring

Returns

string

Defined in

packages/lexical-link/src/index.ts:175


setRel

setRel(rel): void

Parameters

NameType
relnull | string

Returns

void

Defined in

packages/lexical-link/src/index.ts:222


setTarget

setTarget(target): void

Parameters

NameType
targetnull | string

Returns

void

Defined in

packages/lexical-link/src/index.ts:213


setTitle

setTitle(title): void

Parameters

NameType
titlenull | string

Returns

void

Defined in

packages/lexical-link/src/index.ts:231


setURL

setURL(url): void

Parameters

NameType
urlstring

Returns

void

Defined in

packages/lexical-link/src/index.ts:204


updateDOM

updateDOM(prevNode, anchor, config): boolean

Called when a node changes and should update the DOM in whatever way is necessary to make it align with any changes that might have happened during the update.

Returning "true" here will cause lexical to unmount and recreate the DOM node (by calling createDOM). You would need to do this if the element tag changes, for instance.

Parameters

NameType
prevNodeLinkNode
anchorLinkHTMLElementType
configEditorConfig

Returns

boolean

Overrides

ElementNode.updateDOM

Defined in

packages/lexical-link/src/index.ts:111


clone

clone(node): LinkNode

Clones this node, creating a new node with a different key and adding it to the EditorState (but not attaching it anywhere!). All nodes must implement this method.

Parameters

NameType
nodeLinkNode

Returns

LinkNode

Overrides

ElementNode.clone

Defined in

packages/lexical-link/src/index.ts:78


getType

getType(): string

Returns the string type of this node. Every node must implement this and it MUST BE UNIQUE amongst nodes registered on the editor.

Returns

string

Overrides

ElementNode.getType

Defined in

packages/lexical-link/src/index.ts:74


importDOM

importDOM(): null | DOMConversionMap

Returns

null | DOMConversionMap

Overrides

ElementNode.importDOM

Defined in

packages/lexical-link/src/index.ts:152


importJSON

importJSON(serializedNode): LinkNode

Controls how the this node is deserialized from JSON. This is usually boilerplate, but provides an abstraction between the node implementation and serialized interface that can be important if you ever make breaking changes to a node schema (by adding or removing properties). See Serialization & Deserialization.

Parameters

NameType
serializedNodeSerializedLinkNode | SerializedAutoLinkNode

Returns

LinkNode

Overrides

ElementNode.importJSON

Defined in

packages/lexical-link/src/index.ts:161