blessed-components - v1.20.0
    Preparing search index...

    Interface RenderKbdOptions

    Options accepted by renderKbd.

    interface RenderKbdOptions {
        align?: TextAlign;
        keySeparator?: string;
        keys: string | readonly string[];
        normalize?: boolean;
        overflow?: KbdOverflow;
        shortcutSeparator?: string;
        variant?: KbdVariant;
        omission?: string;
        truncatePosition?: "end" | "middle" | "start";
        width?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    align? keySeparator? keys normalize? overflow? shortcutSeparator? variant? omission? truncatePosition? width?

    Properties

    align?: TextAlign

    Horizontal alignment applied after overflow handling.

    'left'

    keySeparator?: string

    Separator inserted between keys in one chord.

    +

    keys: string | readonly string[]

    Keyboard chord or ordered shortcut alternatives.

    Chords may use - or + separators, such as C-s, M-enter, or Ctrl+Shift+P.

    normalize?: boolean

    Whether common terminal modifiers should be expanded to readable names.

    true

    overflow?: KbdOverflow

    Single-line overflow policy.

    'truncate'

    shortcutSeparator?: string

    Separator inserted between shortcut alternatives.

    ' / '

    variant?: KbdVariant

    Visual structure used for each key.

    'bracketed'

    omission?: string

    Omission marker used by truncate overflow.

    '…'

    truncatePosition?: "end" | "middle" | "start"

    Truncation position used by truncate overflow.

    'end'

    width?: number

    Maximum rendered width measured in terminal cells.

    Settings

    Member Visibility

    On This Page

    Properties