Skip to main content

Class: AutoLinkNode

@lexical/link.AutoLinkNode

Hierarchy

Constructors

constructor

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

Parameters

NameType
urlstring
attributesPartial<Spread<LinkAttributes, { isUnlinked?: boolean }>>
key?string

Returns

AutoLinkNode

Overrides

LinkNode.constructor

Defined in

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

Properties

__isUnlinked

__isUnlinked: boolean

Indicates whether the autolink was ever unlinked. *

Defined in

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


constructor

constructor: KlassConstructor<typeof ElementNode>

Inherited from

LinkNode.constructor

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:69

Methods

canBeEmpty

canBeEmpty(): false

Returns

false

Inherited from

LinkNode.canBeEmpty

Defined in

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


canInsertTextAfter

canInsertTextAfter(): false

Returns

false

Inherited from

LinkNode.canInsertTextAfter

Defined in

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


canInsertTextBefore

canInsertTextBefore(): false

Returns

false

Inherited from

LinkNode.canInsertTextBefore

Defined in

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


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

LinkNode.createDOM

Defined in

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


exportJSON

exportJSON(): 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

SerializedAutoLinkNode

Overrides

LinkNode.exportJSON

Defined in

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


extractWithChild

extractWithChild(child, selection, destination): boolean

Parameters

NameType
childLexicalNode
selectionBaseSelection
destination"clone" | "html"

Returns

boolean

Inherited from

LinkNode.extractWithChild

Defined in

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


getIsUnlinked

getIsUnlinked(): boolean

Returns

boolean

Defined in

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


getRel

getRel(): null | string

Returns

null | string

Inherited from

LinkNode.getRel

Defined in

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


getTarget

getTarget(): null | string

Returns

null | string

Inherited from

LinkNode.getTarget

Defined in

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


getTitle

getTitle(): null | string

Returns

null | string

Inherited from

LinkNode.getTitle

Defined in

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


getType

getType(): string

Returns the string type of this node.

Returns

string

Inherited from

LinkNode.getType

Defined in

packages/lexical/src/LexicalNode.ts:291


getURL

getURL(): string

Returns

string

Inherited from

LinkNode.getURL

Defined in

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


insertNewAfter

insertNewAfter(selection, restoreSelection?): null | ElementNode

Parameters

NameTypeDefault value
selectionRangeSelectionundefined
restoreSelectionbooleantrue

Returns

null | ElementNode

Overrides

LinkNode.insertNewAfter

Defined in

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


isEmailURI

isEmailURI(): boolean

Returns

boolean

Inherited from

LinkNode.isEmailURI

Defined in

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


isInline

isInline(): true

Returns

true

Inherited from

LinkNode.isInline

Defined in

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


isWebSiteURI

isWebSiteURI(): boolean

Returns

boolean

Inherited from

LinkNode.isWebSiteURI

Defined in

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


sanitizeUrl

sanitizeUrl(url): string

Parameters

NameType
urlstring

Returns

string

Inherited from

LinkNode.sanitizeUrl

Defined in

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


setIsUnlinked

setIsUnlinked(value): AutoLinkNode

Parameters

NameType
valueboolean

Returns

AutoLinkNode

Defined in

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


setRel

setRel(rel): void

Parameters

NameType
relnull | string

Returns

void

Inherited from

LinkNode.setRel

Defined in

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


setTarget

setTarget(target): void

Parameters

NameType
targetnull | string

Returns

void

Inherited from

LinkNode.setTarget

Defined in

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


setTitle

setTitle(title): void

Parameters

NameType
titlenull | string

Returns

void

Inherited from

LinkNode.setTitle

Defined in

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


setURL

setURL(url): void

Parameters

NameType
urlstring

Returns

void

Inherited from

LinkNode.setURL

Defined in

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


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
prevNodeAutoLinkNode
anchorLinkHTMLElementType
configEditorConfig

Returns

boolean

Overrides

LinkNode.updateDOM

Defined in

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


clone

clone(node): AutoLinkNode

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
nodeAutoLinkNode

Returns

AutoLinkNode

Overrides

LinkNode.clone

Defined in

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


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

LinkNode.getType

Defined in

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


importDOM

importDOM(): null

Returns

null

Overrides

LinkNode.importDOM

Defined in

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


importJSON

importJSON(serializedNode): AutoLinkNode

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
serializedNodeSerializedAutoLinkNode

Returns

AutoLinkNode

Overrides

LinkNode.importJSON

Defined in

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