Skip to main content

Module: @lexical/code

Classes

References

normalizeCodeLanguage

Renames and re-exports normalizeCodeLang

Type Aliases

SerializedCodeNode

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

Defined in

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

Variables

CODE_LANGUAGE_FRIENDLY_NAME_MAP

Const CODE_LANGUAGE_FRIENDLY_NAME_MAP: Record<string, string>

Defined in

packages/lexical-code/src/FacadePrism.ts:45


CODE_LANGUAGE_MAP

Const CODE_LANGUAGE_MAP: Record<string, string>

Defined in

packages/lexical-code/src/FacadePrism.ts:65


DEFAULT_CODE_LANGUAGE

Const DEFAULT_CODE_LANGUAGE: "javascript"

Defined in

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


PrismTokenizer

Const PrismTokenizer: Tokenizer

Defined in

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

Functions

$createCodeHighlightNode

$createCodeHighlightNode(text?, highlightType?): CodeHighlightNode

Parameters

NameTypeDefault value
textstring''
highlightType?null | stringundefined

Returns

CodeHighlightNode

Defined in

packages/lexical-code/src/CodeHighlightNode.ts:153


$createCodeNode

$createCodeNode(language?, theme?): CodeNode

Parameters

NameType
language?null | string
theme?null | string

Returns

CodeNode

Defined in

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


$getEndOfCodeInLine

$getEndOfCodeInLine(anchor): CodeHighlightNode | TabNode

Parameters

NameType
anchorTabNode | CodeHighlightNode

Returns

CodeHighlightNode | TabNode

Defined in

packages/lexical-code/src/FlatStructureUtils.ts:167


$getFirstCodeNodeOfLine

$getFirstCodeNodeOfLine(anchor): CodeHighlightNode | TabNode | LineBreakNode

Parameters

NameType
anchorLineBreakNode | TabNode | CodeHighlightNode

Returns

CodeHighlightNode | TabNode | LineBreakNode

Defined in

packages/lexical-code/src/FlatStructureUtils.ts:42


$getLastCodeNodeOfLine

$getLastCodeNodeOfLine(anchor): CodeHighlightNode | TabNode | LineBreakNode

Parameters

NameType
anchorLineBreakNode | TabNode | CodeHighlightNode

Returns

CodeHighlightNode | TabNode | LineBreakNode

Defined in

packages/lexical-code/src/FlatStructureUtils.ts:48


$getStartOfCodeInLine

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

Parameters

NameType
anchorTabNode | CodeHighlightNode
offsetnumber

Returns

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

Defined in

packages/lexical-code/src/FlatStructureUtils.ts:54


$isCodeHighlightNode

$isCodeHighlightNode(node): node is CodeHighlightNode

Parameters

NameType
nodeundefined | null | LexicalNode | CodeHighlightNode

Returns

node is CodeHighlightNode

Defined in

packages/lexical-code/src/CodeHighlightNode.ts:160


$isCodeNode

$isCodeNode(node): node is CodeNode

Parameters

NameType
nodeundefined | null | LexicalNode

Returns

node is CodeNode

Defined in

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


getCodeLanguageOptions

getCodeLanguageOptions(): [string, string][]

Returns

[string, string][]

Defined in

packages/lexical-code/src/FacadePrism.ts:94


getCodeLanguages

getCodeLanguages(): string[]

Returns

string[]

Defined in

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


getCodeThemeOptions

getCodeThemeOptions(): [string, string][]

Returns

[string, string][]

Defined in

packages/lexical-code/src/FacadePrism.ts:107


getDefaultCodeLanguage

getDefaultCodeLanguage(): string

Returns

string

Defined in

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


getEndOfCodeInLine

getEndOfCodeInLine(anchor): CodeHighlightNode | TabNode

Parameters

NameType
anchorTabNode | CodeHighlightNode

Returns

CodeHighlightNode | TabNode

Deprecated

renamed to $getEndOfCodeInLine by @lexical/eslint-plugin rules-of-lexical

Defined in

packages/lexical-code/src/index.ts:52


getFirstCodeNodeOfLine

getFirstCodeNodeOfLine(anchor): CodeHighlightNode | TabNode | LineBreakNode

Parameters

NameType
anchorLineBreakNode | TabNode | CodeHighlightNode

Returns

CodeHighlightNode | TabNode | LineBreakNode

Deprecated

renamed to $getFirstCodeNodeOfLine by @lexical/eslint-plugin rules-of-lexical

Defined in

packages/lexical-code/src/index.ts:48


getLanguageFriendlyName

getLanguageFriendlyName(lang): string

Parameters

NameType
langstring

Returns

string

Defined in

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


getLastCodeNodeOfLine

getLastCodeNodeOfLine(anchor): CodeHighlightNode | TabNode | LineBreakNode

Parameters

NameType
anchorLineBreakNode | TabNode | CodeHighlightNode

Returns

CodeHighlightNode | TabNode | LineBreakNode

Deprecated

renamed to $getLastCodeNodeOfLine by @lexical/eslint-plugin rules-of-lexical

Defined in

packages/lexical-code/src/index.ts:50


getStartOfCodeInLine

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

Parameters

NameType
anchorTabNode | CodeHighlightNode
offsetnumber

Returns

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

Deprecated

renamed to $getStartOfCodeInLine by @lexical/eslint-plugin rules-of-lexical

Defined in

packages/lexical-code/src/index.ts:54


normalizeCodeLang

normalizeCodeLang(lang): string

Parameters

NameType
langstring

Returns

string

Defined in

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


registerCodeHighlighting

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

Parameters

NameType
editorLexicalEditor
tokenizer?Tokenizer

Returns

fn

▸ (): void

Returns

void

Defined in

packages/lexical-code/src/CodeHighlighterPrism.ts:752