Class: AutoLinkNode
@lexical/link.AutoLinkNode
Hierarchy
-
↳
AutoLinkNode
Constructors
constructor
• new AutoLinkNode(url?, attributes?, key?): AutoLinkNode
Parameters
| Name | Type | Default value |
|---|---|---|
url | string | '' |
attributes | Partial<Spread<LinkAttributes, { isUnlinked?: boolean }>> | {} |
key? | string | undefined |
Returns
Overrides
Defined in
packages/lexical-link/src/index.ts:361
Properties
__isUnlinked
• __isUnlinked: boolean
Indicates whether the autolink was ever unlinked. *
Defined in
packages/lexical-link/src/index.ts:359
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
Defined in
packages/lexical-link/src/index.ts:270
canInsertTextAfter
▸ canInsertTextAfter(): false
Returns
false
Inherited from
Defined in
packages/lexical-link/src/index.ts:266
canInsertTextBefore
▸ canInsertTextBefore(): false
Returns
false
Inherited from
Defined in
packages/lexical-link/src/index.ts:262
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:400
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
Overrides
Defined in
packages/lexical-link/src/index.ts:436
extractWithChild
▸ extractWithChild(child, selection, destination): boolean
Parameters
| Name | Type |
|---|---|
child | LexicalNode |
selection | BaseSelection |
destination | "clone" | "html" |
Returns
boolean
Inherited from
Defined in
packages/lexical-link/src/index.ts:278
getIsUnlinked
▸ getIsUnlinked(): boolean
Returns
boolean
Defined in
packages/lexical-link/src/index.ts:390
getRel
▸ getRel(): null | string
Returns
null | string
Inherited from
Defined in
packages/lexical-link/src/index.ts:229
getTarget
▸ getTarget(): null | string
Returns
null | string
Inherited from
Defined in
packages/lexical-link/src/index.ts:219
getTitle
▸ getTitle(): null | string
Returns
null | string
Inherited from
Defined in
packages/lexical-link/src/index.ts:239
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
Defined in
packages/lexical-link/src/index.ts:209
insertNewAfter
▸ insertNewAfter(selection, restoreSelection?): null | ElementNode
Parameters
| Name | Type | Default value |
|---|---|---|
selection | RangeSelection | undefined |
restoreSelection | boolean | true |
Returns
null | ElementNode
Overrides
Defined in
packages/lexical-link/src/index.ts:443
isEmailURI
▸ isEmailURI(): boolean
Returns
boolean
Inherited from
Defined in
packages/lexical-link/src/index.ts:297
isInline
▸ isInline(): true
Returns
true
Inherited from
Defined in
packages/lexical-link/src/index.ts:274
isWebSiteURI
▸ isWebSiteURI(): boolean
Returns
boolean
Inherited from
Defined in
packages/lexical-link/src/index.ts:301
sanitizeUrl
▸ sanitizeUrl(url): string
Parameters
| Name | Type |
|---|---|
url | string |
Returns
string
Inherited from
Defined in
packages/lexical-link/src/index.ts:186
setIsUnlinked
▸ setIsUnlinked(value): this
Parameters
| Name | Type |
|---|---|
value | boolean |
Returns
this
Defined in
packages/lexical-link/src/index.ts:394
setRel
▸ setRel(rel): this
Parameters
| Name | Type |
|---|---|
rel | null | string |
Returns
this
Inherited from
Defined in
packages/lexical-link/src/index.ts:233
setTarget
▸ setTarget(target): this
Parameters
| Name | Type |
|---|---|
target | null | string |
Returns
this
Inherited from
Defined in
packages/lexical-link/src/index.ts:223
setTitle
▸ setTitle(title): this
Parameters
| Name | Type |
|---|---|
title | null | string |
Returns
this
Inherited from
Defined in
packages/lexical-link/src/index.ts:243
setURL
▸ setURL(url): this
Parameters
| Name | Type |
|---|---|
url | string |
Returns
this
Inherited from
Defined in
packages/lexical-link/src/index.ts:213
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:408
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<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
Defined in
packages/lexical-link/src/index.ts:423
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
| Name | Type |
|---|---|
node | AutoLinkNode |
Returns
Overrides
Defined in
packages/lexical-link/src/index.ts:377
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:373
importDOM
▸ importDOM(): null
Returns
null
Overrides
Defined in
packages/lexical-link/src/index.ts:431
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
| Name | Type |
|---|---|
serializedNode | SerializedAutoLinkNode |