MAIDR JavaScript API
    Preparing search index...

    Interface HelpMenuItem

    Help menu item containing keyboard shortcut and its description.

    interface HelpMenuItem {
        description: string;
        section:
            | "candlestick"
            | "autoplay"
            | "other"
            | "jump"
            | "navigate"
            | "hear"
            | "modes"
            | "tools"
            | "tactile";
        key: string;
        commandKey?: string;
        defaultKey?: string;
        isCustom?: boolean;
        device?: "monarch"
        | "dotPad";
    }
    Index

    Properties

    description section key commandKey? defaultKey? isCustom? device?

    Properties

    description: string
    section:
        | "candlestick"
        | "autoplay"
        | "other"
        | "jump"
        | "navigate"
        | "hear"
        | "modes"
        | "tools"
        | "tactile"

    The group the row is listed under.

    key: string

    The shortcut as the reader should press it, spelled for the help menu.

    commandKey?: string

    The command this row runs, when the reader may give it a shortcut of their own in the settings dialog. Absent on a row that cannot be changed: the help chord itself, and a row reached through a chord such as l x, whose first key belongs to another command.

    defaultKey?: string

    The shortcut the row has out of the box, for a row the reader changed.

    isCustom?: boolean

    Whether key is the reader's own shortcut rather than the default.

    device?: "monarch" | "dotPad"

    The tactile display the keys are on, for a row whose keys are on the display rather than the keyboard. Such a row is never rebound: the device reports its keys and MAIDR answers them, with nothing bound in between.

    Settings

    Member Visibility

    On This Page

    Properties