Class: MarkNode
@lexical/mark.MarkNode
Hierarchy
-
↳
MarkNode
Constructors
constructor
• new MarkNode(ids, key?): MarkNode
Parameters
| Name | Type |
|---|---|
ids | readonly string[] |
key? | string |
Returns
Overrides
Defined in
packages/lexical-mark/src/MarkNode.ts:66
Methods
addID
▸ addID(id): void
Parameters
| Name | Type |
|---|---|
id | string |
Returns
void
Defined in
packages/lexical-mark/src/MarkNode.ts:118
canBeEmpty
▸ canBeEmpty(): false
Returns
false
Overrides
Defined in
packages/lexical-mark/src/MarkNode.ts:164
canInsertTextAfter
▸ canInsertTextAfter(): false
Returns
false
Overrides
ElementNode.canInsertTextAfter
Defined in
packages/lexical-mark/src/MarkNode.ts:160
canInsertTextBefore
▸ canInsertTextBefore(): false
Returns
false
Overrides
ElementNode.canInsertTextBefore
Defined in
packages/lexical-mark/src/MarkNode.ts:156
createDOM
▸ createDOM(config): HTMLElement
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
HTMLElement
Overrides
Defined in
packages/lexical-mark/src/MarkNode.ts:71
deleteID
▸ deleteID(id): void
Parameters
| Name | Type |
|---|---|
id | string |
Returns
void
Defined in
packages/lexical-mark/src/MarkNode.ts:133
excludeFromCopy
▸ excludeFromCopy(destination): boolean
Parameters
| Name | Type |
|---|---|
destination | "clone" | "html" |
Returns
boolean
Overrides
Defined in
packages/lexical-mark/src/MarkNode.ts:195
exportJSON
▸ exportJSON(): SerializedMarkNode
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-mark/src/MarkNode.ts:57
extractWithChild
▸ extractWithChild(child, selection, destination): boolean
Parameters
| Name | Type |
|---|---|
child | LexicalNode |
selection | BaseSelection |
destination | "clone" | "html" |
Returns
boolean
Overrides
Defined in
packages/lexical-mark/src/MarkNode.ts:172
getIDs
▸ getIDs(): string[]
Returns
string[]
Defined in
packages/lexical-mark/src/MarkNode.ts:113
hasID
▸ hasID(id): boolean
Parameters
| Name | Type |
|---|---|
id | string |
Returns
boolean
Defined in
packages/lexical-mark/src/MarkNode.ts:103
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-mark/src/MarkNode.ts:147
isInline
▸ isInline(): true
Returns
true
Overrides
Defined in
packages/lexical-mark/src/MarkNode.ts:168
updateDOM
▸ updateDOM(prevNode, element, 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 |
element | HTMLElement |
config | EditorConfig |
Returns
boolean
Overrides
Defined in
packages/lexical-mark/src/MarkNode.ts:80
clone
▸ clone(node): MarkNode
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 | MarkNode |
Returns
Overrides
Defined in
packages/lexical-mark/src/MarkNode.ts:41
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-mark/src/MarkNode.ts:37
importDOM
▸ importDOM(): null
Returns
null
Overrides
ElementNode.importDOM
Defined in
packages/lexical-mark/src/MarkNode.ts:45
importJSON
▸ importJSON(serializedNode): MarkNode
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 | SerializedMarkNode |