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

    Interface IconButtonData

    Stateful data accepted by the Blessed iconButton adapter.

    interface IconButtonData {
        capabilities?: Pick<TerminalCapabilities, "colorLevel">;
        disabled?: boolean;
        disabledBackgroundTone?: keyof ThemeColors;
        disabledTone?: keyof ThemeColors;
        focusedBackgroundTone?: keyof ThemeColors;
        focusedTone?: keyof ThemeColors;
        icon: string;
        label: string;
        onPress?: () => void;
        backgroundTone?: keyof ThemeColors;
        showLabel?: boolean;
        tone?: keyof ThemeColors;
        theme?: Theme;
        variant?: IconButtonVariant;
    }
    Index

    Properties

    capabilities? disabled? disabledBackgroundTone? disabledTone? focusedBackgroundTone? focusedTone? icon label onPress? backgroundTone? showLabel? tone? theme? variant?

    Properties

    capabilities?: Pick<TerminalCapabilities, "colorLevel">

    Explicit color capability used for deterministic rendering.

    disabled?: boolean

    Whether focus and activation are unavailable.

    disabledBackgroundTone?: keyof ThemeColors

    Semantic background while disabled.

    'background'

    disabledTone?: keyof ThemeColors

    Semantic foreground while disabled.

    'muted'

    focusedBackgroundTone?: keyof ThemeColors

    Semantic background while focused.

    'primary'

    focusedTone?: keyof ThemeColors

    Semantic foreground while focused.

    'foreground'

    icon: string

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

    label: string

    Non-empty, single-line action description.

    onPress?: () => void

    Called after keyboard, mouse, or imperative activation.

    backgroundTone?: keyof ThemeColors

    Semantic background while idle.

    'background'

    showLabel?: boolean

    Whether to render the text label beside the icon.

    tone?: keyof ThemeColors

    Semantic foreground while idle.

    'foreground'

    theme?: Theme

    Semantic terminal theme.

    variant?: IconButtonVariant

    Visual structure.

    'bracketed'

    Settings

    Member Visibility

    On This Page

    Properties