Class: CodeHighlightNode

@lexical/code.CodeHighlightNode

Hierarchy

• TextNode

  ↳ CodeHighlightNode

Constructors

constructor

• new CodeHighlightNode(text, highlightType?, key?)

Parameters

Name	Type
text	string
highlightType?	null | string
key?	string

Overrides

TextNode.constructor

Defined in

packages/lexical-code/src/CodeHighlightNode.ts:98

Methods

canHaveFormat

▸ canHaveFormat(): boolean

Returns

boolean

true if the text node supports font styling, false otherwise.

Overrides

TextNode.canHaveFormat

Defined in

packages/lexical-code/src/CodeHighlightNode.ts:124

---

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

TextNode.createDOM

Defined in

packages/lexical-code/src/CodeHighlightNode.ts:128

---

createParentElementNode

▸ createParentElementNode(): ElementNode

Returns

ElementNode

Overrides

TextNode.createParentElementNode

Defined in

packages/lexical-code/src/CodeHighlightNode.ts:195

---

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

TextNode.exportJSON

Defined in

packages/lexical-code/src/CodeHighlightNode.ts:177

---

getHighlightType

▸ getHighlightType(): undefined | null | string

Returns

undefined | null | string

Defined in

packages/lexical-code/src/CodeHighlightNode.ts:119

---

isParentRequired

▸ isParentRequired(): true

Returns

true

Overrides

TextNode.isParentRequired

Defined in

packages/lexical-code/src/CodeHighlightNode.ts:191

---

setFormat

▸ setFormat(format): CodeHighlightNode

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

CodeHighlightNode

this TextNode. // TODO 0.12 This should just be a string.

Overrides

TextNode.setFormat

Defined in

packages/lexical-code/src/CodeHighlightNode.ts:187

---

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

TextNode.updateDOM

Defined in

packages/lexical-code/src/CodeHighlightNode.ts:138

---

clone

▸ Static 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

CodeHighlightNode

Overrides

TextNode.clone

Defined in

packages/lexical-code/src/CodeHighlightNode.ts:111

---

getType

▸ Static 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

TextNode.getType

Defined in

packages/lexical-code/src/CodeHighlightNode.ts:107

---

importJSON

▸ Static 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

Returns

CodeHighlightNode

Overrides

TextNode.importJSON

Defined in

packages/lexical-code/src/CodeHighlightNode.ts:163