Interface Button

Configuration for a single control button.

Button

interface Button {
    name?: string;
    icon?: string;
    alternateIcon?: string;
    onPress?: (() => void);
    backgroundColor?: {
        default?: string;
        pressed?: string;
    };
    active?: boolean;
    alternateIconComponent?: Element;
    iconComponent?: Element;
    customComponent?: Element;
    color?: string;
    activeColor?: string;
    inActiveColor?: string;
    disabled?: boolean;
    show?: boolean;
}

Properties

name? icon? alternateIcon? onPress? backgroundColor? active? alternateIconComponent? iconComponent? customComponent? color? activeColor? inActiveColor? disabled? show?

Properties

Optionalname

name?: string

Button label/name

Optionalicon

icon?: string

Icon name (FontAwesome5)

OptionalalternateIcon

alternateIcon?: string

Alternate icon name (shown when active)

OptionalonPress

onPress?: (() => void)

Click handler

OptionalbackgroundColor

backgroundColor?: {
    default?: string;
    pressed?: string;
}

Background colors with default and pressed states

Optionalactive

active?: boolean

Whether button is in active state

OptionalalternateIconComponent

alternateIconComponent?: Element

Custom alternate icon component

OptionaliconComponent

iconComponent?: Element

Custom icon component

OptionalcustomComponent

customComponent?: Element

Completely custom button component

Optionalcolor

color?: string

Icon color

OptionalactiveColor

activeColor?: string

Icon color when active

OptionalinActiveColor

inActiveColor?: string

Icon color when inactive

Optionaldisabled

disabled?: boolean

Whether button is disabled

Optionalshow

show?: boolean

Whether to show the button

Settings

Member Visibility

On This Page

Properties