sesaparcours
    Preparing search index...

    Interface VirtualKeyboardKeycap

    interface VirtualKeyboardKeycap {
        aside: string;
        class: string;
        command:
            | string[]
            | [string, any]
            | Selector
            | [string, any, any]
            | [string, any, any, any];
        insert: string;
        key: string;
        label: string;
        latex: string;
        layer: string;
        shift: string | Partial<VirtualKeyboardKeycap>;
        tooltip: string;
        variants: string | (string | Partial<VirtualKeyboardKeycap>)[];
        width: 0.5 | 1 | 1.5 | 2 | 5;
    }
    Index

    Properties

    aside class command insert key label latex layer shift tooltip variants width

    Properties

    aside: string

    Markup displayed with the key label (for example to explain what the symbol of the key is)

    class: string

    CSS classes to apply to the keycap.

    • tex: use the TeX font for its label. Using the tex class is not necessary if using the latex property to define the label.
    • shift: a shift key
    • small: display the label in a smaller size
    • action: an “action” keycap (for arrows, return, etc…)
    • separator w5: a half-width blank used as a separator. Other widths include w15 (1.5 width), w20 (double width) and w50 (five-wide, used for the space bar).
    • bottom, left, right: alignment of the label
    command:
        | string[]
        | [string, any]
        | Selector
        | [string, any, any]
        | [string, any, any, any]

    Command to perform when the keycap is pressed

    insert: string

    LaTeX fragment to insert when the keycap is pressed (ignored if command is specified)

    key: string

    Key to insert when keycap is pressed (ignored if command, insert or latex is specified)

    label: string

    The HTML markup displayed for the keycap

    latex: string

    Label of the key as a LaTeX expression, also the LaTeX inserted if no command or insert property is specified.

    layer: string

    Name of the layer to shift to when the key is pressed

    shift: string | Partial<VirtualKeyboardKeycap>

    Variant of the keycap when the shift key is pressed

    tooltip: string
    variants: string | (string | Partial<VirtualKeyboardKeycap>)[]

    A set of keycap variants displayed on a long press

    variants: [
     '\\alpha',    // Same label as value inserted
     { latex: '\\beta', label: 'beta' }
    ]
    width: 0.5 | 1 | 1.5 | 2 | 5

    Width of the keycap, as a multiple of the standard keycap width

    Settings

    Member Visibility

    On This Page

    Properties