Theia API Documentation v1.67.0
    Preparing search index...

    Interface LocalizedMarkdownProps

    interface LocalizedMarkdownProps {
        args?: FormatType[];
        className?: string;
        defaultMarkdown: string;
        localizationKey: string;
        markdown?: string | MarkdownString;
        markdownOptions?: {
            isTrusted?: boolean | { enabledCommands: string[] };
            supportHtml?: boolean;
            supportThemeIcons?: boolean;
        };
        markdownRenderer: MarkdownRenderer;
        onRender?: (element: undefined | HTMLElement) => void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    args? className? defaultMarkdown localizationKey markdown? markdownOptions? markdownRenderer onRender?

    Properties

    args?: FormatType[]

    Arguments to substitute into the markdown template. Can be strings, numbers, booleans, or undefined.

    className?: string

    Additional CSS class name(s) to apply to the container element.

    defaultMarkdown: string

    The default markdown content (in English) with placeholders. Use {0}, {1}, etc. for parameter substitution.

    localizationKey: string

    The localization key for the markdown content.

    markdown?: string | MarkdownString

    The markdown content to render. Can be a string, a MarkdownString, or undefined. If undefined or empty, an empty div will be rendered.

    markdownOptions?: {
        isTrusted?: boolean | { enabledCommands: string[] };
        supportHtml?: boolean;
        supportThemeIcons?: boolean;
    }

    Options to pass to MarkdownStringImpl if markdown is a string. Common options include:

    • supportHtml: Allow HTML in markdown (default: false)
    • supportThemeIcons: Allow theme icons (default: false)
    • isTrusted: Trust level for command execution (default: false)
    markdownRenderer: MarkdownRenderer

    The MarkdownRenderer instance to use for rendering.

    onRender?: (element: undefined | HTMLElement) => void

    Optional callback that receives the rendered HTML element. Useful for post-processing or adding event listeners. Receives undefined when content is empty.

    Settings

    Member Visibility

    On This Page

    Properties