Perseus
    Preparing search index...

    Type Alias PerseusExplanationWidgetOptions

    Options for the explanation widget. Reveals an explanation on click.

    type PerseusExplanationWidgetOptions = {
        explanation: string;
        hidePrompt: string;
        showPrompt: string;
        static: boolean;
        widgets: PerseusWidgetsMap;
    }
    Index

    Properties

    explanation: string

    Translatable Markdown; The explanation that is shown when showPrompt is clicked. e.g. "An apple is a tasty fruit."

    hidePrompt: string

    Translatable Text; The clickable text to hide an explanation. e.g. "Thanks. I got it!"

    showPrompt: string

    Translatable Text; The clickable text to expand an explanation. e.g. "What is an apple?"

    static: boolean

    Always false. Not used for this widget

    explanation fields can embed widgets. When they do, the details of the widgets are here.