Skip to main content

Module: @lexical/code

Classes

Type Aliases

SerializedCodeNode

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

Defined in

lexical-code/src/CodeNode.ts:52


SerializedCodeTabNode

Ƭ SerializedCodeTabNode: SerializedTabNode

Defined in

lexical-code/src/CodeTabNode.ts:18

Variables

CODE_LANGUAGE_FRIENDLY_NAME_MAP

Const CODE_LANGUAGE_FRIENDLY_NAME_MAP: Record<string, string>

Defined in

lexical-code/src/CodeHighlightNode.ts:53


CODE_LANGUAGE_MAP

Const CODE_LANGUAGE_MAP: Record<string, string>

Defined in

lexical-code/src/CodeHighlightNode.ts:72


DEFAULT_CODE_LANGUAGE

Const DEFAULT_CODE_LANGUAGE: "javascript"

Defined in

lexical-code/src/CodeHighlightNode.ts:44


PrismTokenizer

Const PrismTokenizer: Tokenizer

Defined in

lexical-code/src/CodeHighlighter.ts:81

Functions

$createCodeHighlightNode

$createCodeHighlightNode(text, highlightType?): CodeHighlightNode

Parameters

NameType
textstring
highlightType?null | string

Returns

CodeHighlightNode

Defined in

lexical-code/src/CodeHighlightNode.ts:218


$createCodeNode

$createCodeNode(language?): CodeNode

Parameters

NameType
language?null | string

Returns

CodeNode

Defined in

lexical-code/src/CodeNode.ts:291


$createCodeTabNode

$createCodeTabNode(): CodeTabNode

Returns

CodeTabNode

Defined in

lexical-code/src/CodeTabNode.ts:62


$isCodeHighlightNode

$isCodeHighlightNode(node): node is CodeHighlightNode

Parameters

NameType
nodeundefined | null | LexicalNode | CodeHighlightNode

Returns

node is CodeHighlightNode

Defined in

lexical-code/src/CodeHighlightNode.ts:225


$isCodeNode

$isCodeNode(node): node is CodeNode

Parameters

NameType
nodeundefined | null | LexicalNode

Returns

node is CodeNode

Defined in

lexical-code/src/CodeNode.ts:297


$isCodeTabNode

$isCodeTabNode(node): node is CodeTabNode

Parameters

NameType
nodeundefined | null | LexicalNode

Returns

node is CodeTabNode

Defined in

lexical-code/src/CodeTabNode.ts:66


getCodeLanguages

getCodeLanguages(): string[]

Returns

string[]

Defined in

lexical-code/src/CodeHighlightNode.ts:94


getDefaultCodeLanguage

getDefaultCodeLanguage(): string

Returns

string

Defined in

lexical-code/src/CodeHighlightNode.ts:92


getEndOfCodeInLine

getEndOfCodeInLine(anchor): Object

Parameters

NameType
anchorLexicalNode

Returns

Object

NameType
nodeTextNode | null
offsetnumber

Defined in

lexical-code/src/CodeHighlighter.ts:171


getFirstCodeNodeOfLine

getFirstCodeNodeOfLine(anchor): null | CodeHighlightNode | CodeTabNode | LineBreakNode

Parameters

NameType
anchorLineBreakNode | CodeTabNode | CodeHighlightNode

Returns

null | CodeHighlightNode | CodeTabNode | LineBreakNode

Defined in

lexical-code/src/CodeHighlightNode.ts:231


getLanguageFriendlyName

getLanguageFriendlyName(lang): string

Parameters

NameType
langstring

Returns

string

Defined in

lexical-code/src/CodeHighlightNode.ts:87


getLastCodeNodeOfLine

getLastCodeNodeOfLine(anchor): null | CodeHighlightNode | CodeTabNode | LineBreakNode

Parameters

NameType
anchorLineBreakNode | CodeTabNode | CodeHighlightNode

Returns

null | CodeHighlightNode | CodeTabNode | LineBreakNode

Defined in

lexical-code/src/CodeHighlightNode.ts:243


getStartOfCodeInLine

getStartOfCodeInLine(anchor): Object

Parameters

NameType
anchorLexicalNode

Returns

Object

NameType
nodeTextNode | null
offsetnumber

Defined in

lexical-code/src/CodeHighlighter.ts:123


normalizeCodeLang

normalizeCodeLang(lang): string

Parameters

NameType
langstring

Returns

string

Defined in

lexical-code/src/CodeHighlightNode.ts:83


registerCodeHighlighting

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

Parameters

NameType
editorLexicalEditor
tokenizer?Tokenizer

Returns

fn

▸ (): void

Returns

void

Defined in

lexical-code/src/CodeHighlighter.ts:773