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

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

Methods

canIndent

canIndent(): false

Returns

false

Overrides

ElementNode.canIndent

Defined in

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


collapseAtStart

collapseAtStart(): boolean

Returns

boolean

Overrides

ElementNode.collapseAtStart

Defined in

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


createDOM

createDOM(config): HTMLElement

Parameters

NameType
configEditorConfig

Returns

HTMLElement

Overrides

ElementNode.createDOM

Defined in

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


exportDOM

exportDOM(editor): DOMExportOutput

Parameters

NameType
editorLexicalEditor

Returns

DOMExportOutput

Overrides

ElementNode.exportDOM

Defined in

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


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:210


getLanguage

getLanguage(): undefined | null | string

Returns

undefined | null | string

Defined in

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


insertNewAfter

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

Parameters

NameTypeDefault value
selectionRangeSelectionundefined
restoreSelectionbooleantrue

Returns

null | TabNode | ParagraphNode | CodeHighlightNode

Overrides

ElementNode.insertNewAfter

Defined in

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


setLanguage

setLanguage(language): void

Parameters

NameType
languagestring

Returns

void

Defined in

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


updateDOM

updateDOM(prevNode, dom, config): boolean

Parameters

NameType
prevNodeCodeNode
domHTMLElement
configEditorConfig

Returns

boolean

Overrides

ElementNode.updateDOM

Defined in

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


clone

Static clone(node): CodeNode

Parameters

NameType
nodeCodeNode

Returns

CodeNode

Overrides

ElementNode.clone

Defined in

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


getType

Static getType(): string

Returns

string

Overrides

ElementNode.getType

Defined in

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


importDOM

Static importDOM(): null | DOMConversionMap

Returns

null | DOMConversionMap

Overrides

ElementNode.importDOM

Defined in

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


importJSON

Static importJSON(serializedNode): CodeNode

Parameters

NameType
serializedNodeSerializedCodeNode

Returns

CodeNode

Overrides

ElementNode.importJSON

Defined in

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