Skip to main content

@lexical/code-shiki

Interfaces​

Tokenizer​

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

Properties​

$tokenize()​

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

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

Parameters​
codeNode​

CodeNode

language?​

string

Returns​

LexicalNode[]

defaultLanguage​

defaultLanguage: string

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

defaultTheme​

defaultTheme: string

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

Variables​

CodeHighlighterShikiExtension​

const CodeHighlighterShikiExtension: LexicalExtension<{ tokenizer: Tokenizer; }, "@lexical/code-shiki", unknown, unknown>

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

Add code highlighting support for code blocks with Shiki

ShikiTokenizer​

const ShikiTokenizer: Tokenizer

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

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:760

Parameters​

editor​

LexicalEditor

tokenizer?​

Tokenizer

Returns​

(): void

Returns​

void