Skip to main content

@lexical/code-prism

Interfaces​

CodePrismConfig​

Defined in: packages/lexical-code-prism/src/CodeHighlighterPrism.ts:904

Properties​

disabled​

disabled: boolean

Defined in: packages/lexical-code-prism/src/CodeHighlighterPrism.ts:911

When true, the Prism code highlighter is not registered on the editor. This signal can be flipped at runtime to enable or disable the highlighter, for example to switch between the Prism and Shiki highlighters without rebuilding the editor.

tokenizer​

tokenizer: Tokenizer

Defined in: packages/lexical-code-prism/src/CodeHighlighterPrism.ts:912

Tokenizer​

Defined in: packages/lexical-code-prism/src/CodeHighlighterPrism.ts:85

Properties​

defaultLanguage​

defaultLanguage: string

Defined in: packages/lexical-code-prism/src/CodeHighlighterPrism.ts:86

Methods​

$tokenize()​

$tokenize(codeNode, language?): LexicalNode[]

Defined in: packages/lexical-code-prism/src/CodeHighlighterPrism.ts:88

Parameters​
codeNode​

CodeNode

language?​

string

Returns​

LexicalNode[]

tokenize()​

tokenize(code, language?): (string | Token)[]

Defined in: packages/lexical-code-prism/src/CodeHighlighterPrism.ts:87

Parameters​
code​

string

language?​

string

Returns​

(string | Token)[]

Variables​

CODE_LANGUAGE_FRIENDLY_NAME_MAP​

const CODE_LANGUAGE_FRIENDLY_NAME_MAP: Record<string, string>

Defined in: packages/lexical-code-prism/src/FacadePrism.ts:43

CODE_LANGUAGE_MAP​

const CODE_LANGUAGE_MAP: Record<string, string>

Defined in: packages/lexical-code-prism/src/FacadePrism.ts:63

CodePrismExtension​

const CodePrismExtension: LexicalExtension<CodePrismConfig, "@lexical/code-prism", NamedSignalsOutput<CodePrismConfig>, unknown>

Defined in: packages/lexical-code-prism/src/CodeHighlighterPrism.ts:921

Add code highlighting support for code blocks with Prism.

CodeExtension is a dependency, so the required CodeNode and CodeHighlightNode nodes are registered automatically.

PrismTokenizer​

const PrismTokenizer: Tokenizer

Defined in: packages/lexical-code-prism/src/CodeHighlighterPrism.ts:91

Functions​

getCodeLanguageOptions()​

getCodeLanguageOptions(): [string, string][]

Defined in: packages/lexical-code-prism/src/FacadePrism.ts:92

Returns​

[string, string][]

getCodeLanguages()​

getCodeLanguages(): string[]

Defined in: packages/lexical-code-prism/src/FacadePrism.ts:83

Returns​

string[]

getCodeThemeOptions()​

getCodeThemeOptions(): [string, string][]

Defined in: packages/lexical-code-prism/src/FacadePrism.ts:105

Returns​

[string, string][]

getLanguageFriendlyName()​

getLanguageFriendlyName(lang): string

Defined in: packages/lexical-code-prism/src/FacadePrism.ts:78

Parameters​

lang​

string

Returns​

string

isCodeLanguageLoaded()​

isCodeLanguageLoaded(language): boolean

Defined in: packages/lexical-code-prism/src/FacadePrism.ts:116

Parameters​

language​

string

Returns​

boolean

loadCodeLanguage()​

loadCodeLanguage(language, editor?, codeNodeKey?): Promise<void>

Defined in: packages/lexical-code-prism/src/FacadePrism.ts:127

Parameters​

language​

string

editor?​

LexicalEditor

codeNodeKey?​

string

Returns​

Promise<void>

normalizeCodeLanguage()​

normalizeCodeLanguage(lang): string

Defined in: packages/lexical-code-prism/src/FacadePrism.ts:74

Parameters​

lang​

string

Returns​

string

registerCodeHighlighting()​

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

Defined in: packages/lexical-code-prism/src/CodeHighlighterPrism.ts:756

Parameters​

editor​

LexicalEditor

tokenizer?​

Tokenizer

Returns​

(): void

Returns​

void