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:82

Methods

canBeEmpty

canBeEmpty(): false

Returns

false

Overrides

ElementNode.canBeEmpty

Defined in

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


canInsertTextAfter

canInsertTextAfter(): false

Returns

false

Overrides

ElementNode.canInsertTextAfter

Defined in

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


canInsertTextBefore

canInsertTextBefore(): false

Returns

false

Overrides

ElementNode.canInsertTextBefore

Defined in

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


createDOM

createDOM(config): LinkHTMLElementType

Parameters

NameType
configEditorConfig

Returns

LinkHTMLElementType

Overrides

ElementNode.createDOM

Defined in

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


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:184


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:261


getRel

getRel(): null | string

Returns

null | string

Defined in

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


getTarget

getTarget(): null | string

Returns

null | string

Defined in

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


getTitle

getTitle(): null | string

Returns

null | string

Defined in

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


getURL

getURL(): string

Returns

string

Defined in

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


insertNewAfter

insertNewAfter(_, restoreSelection?): null | ElementNode

Parameters

NameTypeDefault value
_RangeSelectionundefined
restoreSelectionbooleantrue

Returns

null | ElementNode

Overrides

ElementNode.insertNewAfter

Defined in

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


isEmailURI

isEmailURI(): boolean

Returns

boolean

Defined in

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


isInline

isInline(): true

Returns

true

Overrides

ElementNode.isInline

Defined in

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


isWebSiteURI

isWebSiteURI(): boolean

Returns

boolean

Defined in

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


sanitizeUrl

sanitizeUrl(url): string

Parameters

NameType
urlstring

Returns

string

Defined in

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


setRel

setRel(rel): void

Parameters

NameType
relnull | string

Returns

void

Defined in

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


setTarget

setTarget(target): void

Parameters

NameType
targetnull | string

Returns

void

Defined in

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


setTitle

setTitle(title): void

Parameters

NameType
titlenull | string

Returns

void

Defined in

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


setURL

setURL(url): void

Parameters

NameType
urlstring

Returns

void

Defined in

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


updateDOM

updateDOM(prevNode, anchor, config): boolean

Parameters

NameType
prevNodeLinkNode
anchorLinkHTMLElementType
configEditorConfig

Returns

boolean

Overrides

ElementNode.updateDOM

Defined in

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


clone

clone(node): LinkNode

Parameters

NameType
nodeLinkNode

Returns

LinkNode

Overrides

ElementNode.clone

Defined in

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


getType

getType(): string

Returns

string

Overrides

ElementNode.getType

Defined in

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


importDOM

importDOM(): null | DOMConversionMap

Returns

null | DOMConversionMap

Overrides

ElementNode.importDOM

Defined in

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


importJSON

importJSON(serializedNode): LinkNode

Parameters

NameType
serializedNodeSerializedLinkNode | SerializedAutoLinkNode

Returns

LinkNode

Overrides

ElementNode.importJSON

Defined in

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