Skip to main content

Class: CodeNode

@lexical/code.CodeNode

Hierarchy

Constructors

constructor

new CodeNode(language?, key?): CodeNode

Parameters

NameType
language?null | string
key?string

Returns

CodeNode

Overrides

ElementNode.constructor

Defined in

packages/lexical-code/src/CodeNode.ts:89

Methods

canIndent

canIndent(): false

Returns

false

Overrides

ElementNode.canIndent

Defined in

packages/lexical-code/src/CodeNode.ts:314


collapseAtStart

collapseAtStart(): boolean

Returns

boolean

Overrides

ElementNode.collapseAtStart

Defined in

packages/lexical-code/src/CodeNode.ts:318


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

NameTypeDescription
configEditorConfigallows access to things like the EditorTheme (to apply classes) during reconciliation.

Returns

HTMLElement

Overrides

ElementNode.createDOM

Defined in

packages/lexical-code/src/CodeNode.ts:96


exportDOM

exportDOM(editor): DOMExportOutput

Controls how the this node is serialized to HTML. This is important for copy and paste between Lexical and non-Lexical editors, or Lexical editors with different namespaces, in which case the primary transfer format is HTML. It's also important if you're serializing to HTML for any other reason via $generateHtmlFromNodes. You could also use this method to build your own HTML renderer.

Parameters

NameType
editorLexicalEditor

Returns

DOMExportOutput

Overrides

ElementNode.exportDOM

Defined in

packages/lexical-code/src/CodeNode.ts:136


exportJSON

exportJSON(): SerializedCodeNode

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

SerializedCodeNode

Overrides

ElementNode.exportJSON

Defined in

packages/lexical-code/src/CodeNode.ts:226


getIsSyntaxHighlightSupported

getIsSyntaxHighlightSupported(): boolean

Returns

boolean

Defined in

packages/lexical-code/src/CodeNode.ts:337


getLanguage

getLanguage(): undefined | null | string

Returns

undefined | null | string

Defined in

packages/lexical-code/src/CodeNode.ts:333


insertNewAfter

insertNewAfter(selection, restoreSelection?): null | ParagraphNode | TabNode | CodeHighlightNode

Parameters

NameTypeDefault value
selectionRangeSelectionundefined
restoreSelectionbooleantrue

Returns

null | ParagraphNode | TabNode | CodeHighlightNode

Overrides

ElementNode.insertNewAfter

Defined in

packages/lexical-code/src/CodeNode.ts:236


setLanguage

setLanguage(language): void

Parameters

NameType
languagestring

Returns

void

Defined in

packages/lexical-code/src/CodeNode.ts:326


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

NameType
prevNodeCodeNode
domHTMLElement
configEditorConfig

Returns

boolean

Overrides

ElementNode.updateDOM

Defined in

packages/lexical-code/src/CodeNode.ts:110


clone

clone(node): CodeNode

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

NameType
nodeCodeNode

Returns

CodeNode

Overrides

ElementNode.clone

Defined in

packages/lexical-code/src/CodeNode.ts:85


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

ElementNode.getType

Defined in

packages/lexical-code/src/CodeNode.ts:81


importDOM

importDOM(): null | DOMConversionMap

Returns

null | DOMConversionMap

Overrides

ElementNode.importDOM

Defined in

packages/lexical-code/src/CodeNode.ts:151


importJSON

importJSON(serializedNode): CodeNode

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

NameType
serializedNodeSerializedCodeNode

Returns

CodeNode

Overrides

ElementNode.importJSON

Defined in

packages/lexical-code/src/CodeNode.ts:218