Class: CodeHighlightNode
@lexical/code.CodeHighlightNode
Hierarchy
-
↳
CodeHighlightNode
Constructors
constructor
• new CodeHighlightNode(text, highlightType?, key?): CodeHighlightNode
Parameters
| Name | Type |
|---|---|
text | string |
highlightType? | null | string |
key? | string |
Returns
Overrides
Defined in
packages/lexical-code/src/CodeHighlightNode.ts:100
Methods
canHaveFormat
▸ canHaveFormat(): boolean
Returns
boolean
true if the text node supports font styling, false otherwise.
Overrides
Defined in
packages/lexical-code/src/CodeHighlightNode.ts:126
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-code/src/CodeHighlightNode.ts:130
createParentElementNode
▸ createParentElementNode(): ElementNode
The creation logic for any required parent. Should be implemented if isParentRequired returns true.
Returns
Overrides
TextNode.createParentElementNode
Defined in
packages/lexical-code/src/CodeHighlightNode.ts:197
exportJSON
▸ exportJSON(): SerializedCodeHighlightNode
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
SerializedCodeHighlightNode
Overrides
Defined in
packages/lexical-code/src/CodeHighlightNode.ts:179
getHighlightType
▸ getHighlightType(): undefined | null | string
Returns
undefined | null | string
Defined in
packages/lexical-code/src/CodeHighlightNode.ts:121
isParentRequired
▸ isParentRequired(): true
Whether or not this node has a required parent. Used during copy + paste operations to normalize nodes that would otherwise be orphaned. For example, ListItemNodes without a ListNode parent or TextNodes with a ParagraphNode parent.
Returns
true
Overrides
Defined in
packages/lexical-code/src/CodeHighlightNode.ts:193
setFormat
▸ setFormat(format): this
Sets the node format to the provided TextFormatType or 32-bit integer. Note that the TextFormatType version of the argument can only specify one format and doing so will remove all other formats that may be applied to the node. For toggling behavior, consider using TextNode.toggleFormat
Parameters
| Name | Type | Description |
|---|---|---|
format | number | TextFormatType or 32-bit integer representing the node format. |
Returns
this
this TextNode.
// TODO 0.12 This should just be a string.
Overrides
Defined in
packages/lexical-code/src/CodeHighlightNode.ts:189
updateDOM
▸ updateDOM(prevNode, dom, 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 | CodeHighlightNode |
dom | HTMLElement |
config | EditorConfig |
Returns
boolean
Overrides
Defined in
packages/lexical-code/src/CodeHighlightNode.ts:140
clone
▸ clone(node): CodeHighlightNode
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 | CodeHighlightNode |
Returns
Overrides
Defined in
packages/lexical-code/src/CodeHighlightNode.ts:113
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-code/src/CodeHighlightNode.ts:109
importJSON
▸ importJSON(serializedNode): CodeHighlightNode
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 | SerializedCodeHighlightNode |