Interface HighlightCodeOptions

interface HighlightCodeOptions {
    getLanguage?: GetCodeLanguage;
    highlightCode?: DangerouslyHighlightCode;
    highlightElement?: HighlightElement;
}

Hierarchy (view full)

Properties

getLanguage? highlightCode? highlightElement?

Properties

Optional getLanguage

getLanguage?: GetCodeLanguage

A function that can be used to get the language for a block of code or allow different aliases.

Returns

The language to use

Optional highlightCode

highlightCode?: DangerouslyHighlightCode

This function is mostly used if you'd like to be able to have the code highlighted via dangerouslySetInnerHTML so that the code can be highlighted in node environments.

Returns

the html to dangerously set within a <code> tag

Optional highlightElement

highlightElement?: HighlightElement

A function that should highlight all the code within an HTMLElement. This should normally just be something like Prism.highlightElement or HighlightJS.highlightElement.

Settings

Member Visibility

Theme

On This Page

getLanguagehighlightCodehighlightElement