Skip to main content

@lexical/code-shiki

Interfaces​

CodeShikiConfig​

Defined in: packages/lexical-code-shiki/src/CodeHighlighterShiki.ts:927

Properties​

disabled​

disabled: boolean

Defined in: packages/lexical-code-shiki/src/CodeHighlighterShiki.ts:934

When true, the Shiki 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-shiki/src/CodeHighlighterShiki.ts:935

Tokenizer​

Defined in: packages/lexical-code-shiki/src/CodeHighlighterShiki.ts:77

Properties​

$tokenize()​

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

Defined in: packages/lexical-code-shiki/src/CodeHighlighterShiki.ts:80

Parameters​
this​

Tokenizer

codeNode​

CodeNode

language?​

string

Returns​

LexicalNode[]

defaultLanguage​

defaultLanguage: string

Defined in: packages/lexical-code-shiki/src/CodeHighlighterShiki.ts:78

defaultTheme​

defaultTheme: string

Defined in: packages/lexical-code-shiki/src/CodeHighlighterShiki.ts:79

Variables​

CodeShikiExtension​

const CodeShikiExtension: LexicalExtension<CodeShikiConfig, "@lexical/code-shiki", NamedSignalsOutput<CodeShikiConfig>, unknown>

Defined in: packages/lexical-code-shiki/src/CodeHighlighterShiki.ts:944

Add code highlighting support for code blocks with Shiki.

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

ShikiTokenizer​

const ShikiTokenizer: Tokenizer

Defined in: packages/lexical-code-shiki/src/CodeHighlighterShiki.ts:89

Functions​

getCodeLanguageOptions()​

getCodeLanguageOptions(): [string, string][]

Defined in: packages/lexical-code-shiki/src/FacadeShiki.ts:119

Returns​

[string, string][]

getCodeThemeOptions()​

getCodeThemeOptions(): [string, string][]

Defined in: packages/lexical-code-shiki/src/FacadeShiki.ts:122

Returns​

[string, string][]

isCodeLanguageLoaded()​

isCodeLanguageLoaded(language): boolean

Defined in: packages/lexical-code-shiki/src/FacadeShiki.ts:38

Parameters​

language​

string

Returns​

boolean

loadCodeLanguage()​

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

Defined in: packages/lexical-code-shiki/src/FacadeShiki.ts:51

Parameters​

language​

string

editor?​

LexicalEditor

codeNodeKey?​

string

Returns​

undefined | Promise<void>

loadCodeTheme()​

loadCodeTheme(theme, editor?, codeNodeKey?): undefined | Promise<void>

Defined in: packages/lexical-code-shiki/src/FacadeShiki.ts:97

Parameters​

theme​

string

editor?​

LexicalEditor

codeNodeKey?​

string

Returns​

undefined | Promise<void>

normalizeCodeLanguage()​

normalizeCodeLanguage(language): string

Defined in: packages/lexical-code-shiki/src/FacadeShiki.ts:126

Parameters​

language​

string

Returns​

string

registerCodeHighlighting()​

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

Defined in: packages/lexical-code-shiki/src/CodeHighlighterShiki.ts:769

Parameters​

editor​

LexicalEditor

tokenizer?​

Tokenizer

Returns​

(): void

Returns​

void