Class: LinkNode

@lexical/link.LinkNode

Hierarchy

• ElementNode

  ↳ LinkNode

  ↳↳ AutoLinkNode

Constructors

constructor

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

Parameters

Name	Type	Default value
url	string	''
attributes	LinkAttributes	{}
key?	string	undefined

Returns

LinkNode

Overrides

ElementNode.constructor

Defined in

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

Methods

canBeEmpty

▸ canBeEmpty(): false

Returns

false

Overrides

ElementNode.canBeEmpty

Defined in

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

---

canInsertTextAfter

▸ canInsertTextAfter(): false

Returns

false

Overrides

ElementNode.canInsertTextAfter

Defined in

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

---

canInsertTextBefore

▸ canInsertTextBefore(): false

Returns

false

Overrides

ElementNode.canInsertTextBefore

Defined in

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

---

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

Name	Type	Description
config	EditorConfig	allows access to things like the EditorTheme (to apply classes) during reconciliation.

Returns

LinkHTMLElementType

Overrides

ElementNode.createDOM

Defined in

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

---

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

---

extractWithChild

▸ extractWithChild(child, selection, destination): boolean

Parameters

Name	Type
child	LexicalNode
selection	BaseSelection
destination	"clone" | "html"

Returns

boolean

Overrides

ElementNode.extractWithChild

Defined in

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

---

getRel

▸ getRel(): null | string

Returns

null | string

Defined in

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

---

getTarget

▸ getTarget(): null | string

Returns

null | string

Defined in

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

---

getTitle

▸ getTitle(): null | string

Returns

null | string

Defined in

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

---

getURL

▸ getURL(): string

Returns

string

Defined in

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

---

insertNewAfter

▸ insertNewAfter(_, restoreSelection?): null | ElementNode

Parameters

Name	Type	Default value
_	RangeSelection	undefined
restoreSelection	boolean	true

Returns

null | ElementNode

Overrides

ElementNode.insertNewAfter

Defined in

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

---

isEmailURI

▸ isEmailURI(): boolean

Returns

boolean

Defined in

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

---

isInline

▸ isInline(): true

Returns

true

Overrides

ElementNode.isInline

Defined in

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

---

isWebSiteURI

▸ isWebSiteURI(): boolean

Returns

boolean

Defined in

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

---

sanitizeUrl

▸ sanitizeUrl(url): string

Parameters

Name	Type
url	string

Returns

string

Defined in

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

---

setRel

▸ setRel(rel): this

Parameters

Name	Type
rel	null | string

Returns

this

Defined in

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

---

setTarget

▸ setTarget(target): this

Parameters

Name	Type
target	null | string

Returns

this

Defined in

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

---

setTitle

▸ setTitle(title): this

Parameters

Name	Type
title	null | string

Returns

this

Defined in

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

---

setURL

▸ setURL(url): this

Parameters

Name	Type
url	string

Returns

this

Defined in

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

---

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

Name	Type
prevNode	this
anchor	LinkHTMLElementType
config	EditorConfig

Returns

boolean

Overrides

ElementNode.updateDOM

Defined in

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

---

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

Name	Type
serializedNode	LexicalUpdateJSON<SerializedLinkNode>

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

ElementNode.updateFromJSON

Defined in

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

---

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

Name	Type
node	LinkNode

Returns

LinkNode

Overrides

ElementNode.clone

Defined in

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

---

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

---

importDOM

▸ importDOM(): null | DOMConversionMap

Returns

null | DOMConversionMap

Overrides

ElementNode.importDOM

Defined in

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

---

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

Name	Type
serializedNode	SerializedLinkNode

Returns

LinkNode

Overrides

ElementNode.importJSON

Defined in

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