Skip to main content

Class: CodeNode

@lexical/code.CodeNode

Hierarchy

Constructors

constructor

new CodeNode(language?, key?)

Parameters

NameType
language?null | string
key?string

Overrides

ElementNode.constructor

Defined in

lexical-code/src/CodeNode.ts:96

Methods

canIndent

canIndent(): false

Returns

false

Overrides

ElementNode.canIndent

Defined in

lexical-code/src/CodeNode.ts:286


collapseAtStart

collapseAtStart(): boolean

Returns

boolean

Overrides

ElementNode.collapseAtStart

Defined in

lexical-code/src/CodeNode.ts:290


createDOM

createDOM(config): HTMLElement

Parameters

NameType
configEditorConfig

Returns

HTMLElement

Overrides

ElementNode.createDOM

Defined in

lexical-code/src/CodeNode.ts:102


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

lexical-code/src/CodeNode.ts:211


getLanguage

getLanguage(): undefined | null | string

Returns

undefined | null | string

Defined in

lexical-code/src/CodeNode.ts:303


insertNewAfter

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

Parameters

NameTypeDefault value
selectionRangeSelectionundefined
restoreSelectionbooleantrue

Returns

null | TabNode | ParagraphNode | CodeHighlightNode

Overrides

ElementNode.insertNewAfter

Defined in

lexical-code/src/CodeNode.ts:221


setLanguage

setLanguage(language): void

Parameters

NameType
languagestring

Returns

void

Defined in

lexical-code/src/CodeNode.ts:298


updateDOM

updateDOM(prevNode, dom, config): boolean

Parameters

NameType
prevNodeCodeNode
domHTMLElement
configEditorConfig

Returns

boolean

Overrides

ElementNode.updateDOM

Defined in

lexical-code/src/CodeNode.ts:112


clone

Static clone(node): CodeNode

Parameters

NameType
nodeCodeNode

Returns

CodeNode

Overrides

ElementNode.clone

Defined in

lexical-code/src/CodeNode.ts:92


getType

Static getType(): string

Returns

string

Overrides

ElementNode.getType

Defined in

lexical-code/src/CodeNode.ts:88


importDOM

Static importDOM(): null | DOMConversionMap<HTMLElement>

Returns

null | DOMConversionMap<HTMLElement>

Defined in

lexical-code/src/CodeNode.ts:130


importJSON

Static importJSON(serializedNode): CodeNode

Parameters

NameType
serializedNodeSerializedCodeNode

Returns

CodeNode

Overrides

ElementNode.importJSON

Defined in

lexical-code/src/CodeNode.ts:203