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

    Interface RenderIconButtonOptions

    Options accepted by renderIconButton.

    interface RenderIconButtonOptions {
        disabled?: boolean;
        focused?: boolean;
        icon: string;
        label: string;
        showLabel?: boolean;
        variant?: IconButtonVariant;
    }
    Index

    Properties

    disabled? focused? icon label showLabel? variant?

    Properties

    disabled?: boolean

    Whether activation is unavailable.

    focused?: boolean

    Whether the button currently owns terminal focus.

    icon: string

    Non-empty, single-line visible icon or glyph.

    label: string

    Non-empty, single-line action description. Required for accessible naming.

    showLabel?: boolean

    Whether to render the text label beside the icon.

    false

    variant?: IconButtonVariant

    Visual structure.

    'bracketed'

    Settings

    Member Visibility

    On This Page

    Properties