Class: LinkNode
@lexical/link.LinkNode
Hierarchy
-
↳
LinkNode↳↳
AutoLinkNode
Constructors
constructor
• new LinkNode(url, attributes?, key?): LinkNode
Parameters
| Name | Type |
|---|---|
url | string |
attributes | LinkAttributes |
key? | string |
Returns
Overrides
Defined in
packages/lexical-link/src/index.ts:90
Methods
canBeEmpty
▸ canBeEmpty(): false
Returns
false
Overrides
Defined in
packages/lexical-link/src/index.ts:259
canInsertTextAfter
▸ canInsertTextAfter(): false
Returns
false
Overrides
ElementNode.canInsertTextAfter
Defined in
packages/lexical-link/src/index.ts:255
canInsertTextBefore
▸ canInsertTextBefore(): false
Returns
false
Overrides
ElementNode.canInsertTextBefore
Defined in
packages/lexical-link/src/index.ts:251
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
Defined in
packages/lexical-link/src/index.ts:99
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
Defined in
packages/lexical-link/src/index.ts:192
extractWithChild
▸ extractWithChild(child, selection, destination): boolean
Parameters
| Name | Type |
|---|---|
child | LexicalNode |
selection | BaseSelection |
destination | "clone" | "html" |
Returns
boolean
Overrides
Defined in
packages/lexical-link/src/index.ts:267
getRel
▸ getRel(): null | string
Returns
null | string
Defined in
packages/lexical-link/src/index.ts:220
getTarget
▸ getTarget(): null | string
Returns
null | string
Defined in
packages/lexical-link/src/index.ts:211
getTitle
▸ getTitle(): null | string
Returns
null | string
Defined in
packages/lexical-link/src/index.ts:229
getURL
▸ getURL(): string
Returns
string
Defined in
packages/lexical-link/src/index.ts:202
insertNewAfter
▸ insertNewAfter(_, restoreSelection?): null | ElementNode
Parameters
| Name | Type | Default value |
|---|---|---|
_ | RangeSelection | undefined |
restoreSelection | boolean | true |
Returns
null | ElementNode
Overrides
Defined in
packages/lexical-link/src/index.ts:238
isEmailURI
▸ isEmailURI(): boolean
Returns
boolean
Defined in
packages/lexical-link/src/index.ts:286
isInline
▸ isInline(): true
Returns
true
Overrides
Defined in
packages/lexical-link/src/index.ts:263
isWebSiteURI
▸ isWebSiteURI(): boolean
Returns
boolean
Defined in
packages/lexical-link/src/index.ts:290
sanitizeUrl
▸ sanitizeUrl(url): string
Parameters
| Name | Type |
|---|---|
url | string |
Returns
string
Defined in
packages/lexical-link/src/index.ts:179
setRel
▸ setRel(rel): void
Parameters
| Name | Type |
|---|---|
rel | null | string |
Returns
void
Defined in
packages/lexical-link/src/index.ts:224
setTarget
▸ setTarget(target): void
Parameters
| Name | Type |
|---|---|
target | null | string |
Returns
void
Defined in
packages/lexical-link/src/index.ts:215
setTitle
▸ setTitle(title): void
Parameters
| Name | Type |
|---|---|
title | null | string |
Returns
void
Defined in
packages/lexical-link/src/index.ts:233
setURL
▸ setURL(url): void
Parameters
| Name | Type |
|---|---|
url | string |
Returns
void
Defined in
packages/lexical-link/src/index.ts:206
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
Defined in
packages/lexical-link/src/index.ts:115
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
Overrides
Defined in
packages/lexical-link/src/index.ts:82
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
Defined in
packages/lexical-link/src/index.ts:78
importDOM
▸ importDOM(): null | DOMConversionMap
Returns
null | DOMConversionMap
Overrides
ElementNode.importDOM
Defined in
packages/lexical-link/src/index.ts:156
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 | SerializedAutoLinkNode |