Module: @lexical/code

Classes

• CodeHighlightNode
• CodeNode

Type Aliases

SerializedCodeNode

Ƭ SerializedCodeNode: Spread<{ language: string | null | undefined }, SerializedElementNode>

Defined in

lexical-code/src/CodeNode.ts:55

Variables

CODE_LANGUAGE_FRIENDLY_NAME_MAP

• Const CODE_LANGUAGE_FRIENDLY_NAME_MAP: Record<string, string>

Defined in

lexical-code/src/CodeHighlightNode.ts:58

---

CODE_LANGUAGE_MAP

• Const CODE_LANGUAGE_MAP: Record<string, string>

Defined in

lexical-code/src/CodeHighlightNode.ts:77

---

DEFAULT_CODE_LANGUAGE

• Const DEFAULT_CODE_LANGUAGE: "javascript"

Defined in

lexical-code/src/CodeHighlightNode.ts:49

---

PrismTokenizer

• Const PrismTokenizer: Tokenizer

Defined in

lexical-code/src/CodeHighlighter.ts:87

Functions

$createCodeHighlightNode

▸ $createCodeHighlightNode(text, highlightType?): CodeHighlightNode

Parameters

Name	Type
text	string
highlightType?	null | string

Returns

CodeHighlightNode

Defined in

lexical-code/src/CodeHighlightNode.ts:223

---

$createCodeNode

▸ $createCodeNode(language?): CodeNode

Parameters

Name	Type
language?	null | string

Returns

CodeNode

Defined in

lexical-code/src/CodeNode.ts:308

---

$isCodeHighlightNode

▸ $isCodeHighlightNode(node): node is CodeHighlightNode

Parameters

Name	Type
node	undefined | null | LexicalNode | CodeHighlightNode

Returns

node is CodeHighlightNode

Defined in

lexical-code/src/CodeHighlightNode.ts:230

---

$isCodeNode

▸ $isCodeNode(node): node is CodeNode

Parameters

Name	Type
node	undefined | null | LexicalNode

Returns

node is CodeNode

Defined in

lexical-code/src/CodeNode.ts:314

---

getCodeLanguages

▸ getCodeLanguages(): string[]

Returns

string[]

Defined in

lexical-code/src/CodeHighlightNode.ts:99

---

getDefaultCodeLanguage

▸ getDefaultCodeLanguage(): string

Returns

string

Defined in

lexical-code/src/CodeHighlightNode.ts:97

---

getEndOfCodeInLine

▸ getEndOfCodeInLine(anchor): CodeHighlightNode | TabNode

Parameters

Name	Type
anchor	TabNode | CodeHighlightNode

Returns

CodeHighlightNode | TabNode

Defined in

lexical-code/src/CodeHighlighter.ts:210

---

getFirstCodeNodeOfLine

▸ getFirstCodeNodeOfLine(anchor): null | CodeHighlightNode | TabNode | LineBreakNode

Parameters

Name	Type
anchor	LineBreakNode | TabNode | CodeHighlightNode

Returns

null | CodeHighlightNode | TabNode | LineBreakNode

Defined in

lexical-code/src/CodeHighlightNode.ts:236

---

getLanguageFriendlyName

▸ getLanguageFriendlyName(lang): string

Parameters

Name	Type
lang	string

Returns

string

Defined in

lexical-code/src/CodeHighlightNode.ts:92

---

getLastCodeNodeOfLine

▸ getLastCodeNodeOfLine(anchor): CodeHighlightNode | TabNode | LineBreakNode

Parameters

Name	Type
anchor	LineBreakNode | TabNode | CodeHighlightNode

Returns

CodeHighlightNode | TabNode | LineBreakNode

Defined in

lexical-code/src/CodeHighlightNode.ts:248

---

getStartOfCodeInLine

▸ getStartOfCodeInLine(anchor, offset): null | { node: CodeHighlightNode | TabNode | LineBreakNode ; offset: number }

Parameters

Name	Type
anchor	TabNode | CodeHighlightNode
offset	number

Returns

null | { node: CodeHighlightNode | TabNode | LineBreakNode ; offset: number }

Defined in

lexical-code/src/CodeHighlighter.ts:97

---

normalizeCodeLang

▸ normalizeCodeLang(lang): string

Parameters

Name	Type
lang	string

Returns

string

Defined in

lexical-code/src/CodeHighlightNode.ts:88

---

registerCodeHighlighting

▸ registerCodeHighlighting(editor, tokenizer?): () => void

Parameters

Name	Type
editor	LexicalEditor
tokenizer?	Tokenizer

Returns

fn

▸ (): void

Returns

void

Defined in

lexical-code/src/CodeHighlighter.ts:828