Skip to main content

Class: AutoLinkNode

@lexical/link.AutoLinkNode

Hierarchy

Constructors

constructor

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

Parameters

NameTypeDefault value
urlstring''
attributesPartial<Spread<LinkAttributes, { isUnlinked?: boolean }>>{}
key?stringundefined

Returns

AutoLinkNode

Overrides

LinkNode.constructor

Defined in

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

Properties

__isUnlinked

__isUnlinked: boolean

Indicates whether the autolink was ever unlinked. *

Defined in

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


constructor

constructor: KlassConstructor<typeof ElementNode>

Inherited from

LinkNode.constructor

Defined in

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

Methods

canBeEmpty

canBeEmpty(): false

Returns

false

Inherited from

LinkNode.canBeEmpty

Defined in

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


canInsertTextAfter

canInsertTextAfter(): false

Returns

false

Inherited from

LinkNode.canInsertTextAfter

Defined in

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


canInsertTextBefore

canInsertTextBefore(): false

Returns

false

Inherited from

LinkNode.canInsertTextBefore

Defined in

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


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


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


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


getIsUnlinked

getIsUnlinked(): boolean

Returns

boolean

Defined in

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


getRel

getRel(): null | string

Returns

null | string

Inherited from

LinkNode.getRel

Defined in

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


getTarget

getTarget(): null | string

Returns

null | string

Inherited from

LinkNode.getTarget

Defined in

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


getTitle

getTitle(): null | string

Returns

null | string

Inherited from

LinkNode.getTitle

Defined in

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


getType

getType(): string

Returns the string type of this node.

Returns

string

Inherited from

LinkNode.getType

Defined in

packages/lexical/src/LexicalNode.ts:336


getURL

getURL(): string

Returns

string

Inherited from

LinkNode.getURL

Defined in

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


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


isEmailURI

isEmailURI(): boolean

Returns

boolean

Inherited from

LinkNode.isEmailURI

Defined in

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


isInline

isInline(): true

Returns

true

Inherited from

LinkNode.isInline

Defined in

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


isWebSiteURI

isWebSiteURI(): boolean

Returns

boolean

Inherited from

LinkNode.isWebSiteURI

Defined in

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


sanitizeUrl

sanitizeUrl(url): string

Parameters

NameType
urlstring

Returns

string

Inherited from

LinkNode.sanitizeUrl

Defined in

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


setIsUnlinked

setIsUnlinked(value): this

Parameters

NameType
valueboolean

Returns

this

Defined in

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


setRel

setRel(rel): this

Parameters

NameType
relnull | string

Returns

this

Inherited from

LinkNode.setRel

Defined in

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


setTarget

setTarget(target): this

Parameters

NameType
targetnull | string

Returns

this

Inherited from

LinkNode.setTarget

Defined in

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


setTitle

setTitle(title): this

Parameters

NameType
titlenull | string

Returns

this

Inherited from

LinkNode.setTitle

Defined in

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


setURL

setURL(url): this

Parameters

NameType
urlstring

Returns

this

Inherited from

LinkNode.setURL

Defined in

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


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

Returns

boolean

Overrides

LinkNode.updateDOM

Defined in

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


updateFromJSON

updateFromJSON(serializedNode): this

Update this LexicalNode instance from serialized JSON. It's recommended to implement as much logic as possible in this method instead of the static importJSON method, so that the functionality can be inherited in subclasses.

The LexicalUpdateJSON utility type should be used to ignore any type, version, or children properties in the JSON so that the extended JSON from subclasses are acceptable parameters for the super call.

If overridden, this method must call super.

Parameters

NameType
serializedNodeLexicalUpdateJSON<SerializedAutoLinkNode>

Returns

this

Example

class MyTextNode extends TextNode {
// ...
static importJSON(serializedNode: SerializedMyTextNode): MyTextNode {
return $createMyTextNode()
.updateFromJSON(serializedNode);
}
updateFromJSON(
serializedNode: LexicalUpdateJSON<SerializedMyTextNode>,
): this {
return super.updateFromJSON(serializedNode)
.setMyProperty(serializedNode.myProperty);
}
}

Overrides

LinkNode.updateFromJSON

Defined in

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


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


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


importDOM

importDOM(): null

Returns

null

Overrides

LinkNode.importDOM

Defined in

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


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