Interface Button

interface Button {
    name?: string;
    icon?: IconDefinition;
    alternateIcon?: IconDefinition;
    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;
    style?: CSSProperties;
    className?: string;
    buttonProps?: ButtonHTMLAttributes<HTMLButtonElement>;
    iconWrapperProps?: HTMLAttributes<HTMLSpanElement>;
    textProps?: HTMLAttributes<HTMLSpanElement>;
    contentWrapperProps?: HTMLAttributes<HTMLDivElement>;
    renderContent?: ((options: {
        index: number;
        isActive: boolean;
        defaultIcon: ReactNode;
        defaultLabel: ReactNode;
        defaultContent: ReactNode;
        vertical: boolean;
    }) => ReactNode);
}

Properties

name? icon? alternateIcon? onPress? backgroundColor? active? alternateIconComponent? iconComponent? customComponent? color? activeColor? inActiveColor? disabled? show? style? className? buttonProps? iconWrapperProps? textProps? contentWrapperProps? renderContent?

Properties

Optionalname

name?: string

Optionalicon

icon?: IconDefinition

OptionalalternateIcon

alternateIcon?: IconDefinition

OptionalonPress

onPress?: (() => void)

OptionalbackgroundColor

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

Optionalactive

active?: boolean

OptionalalternateIconComponent

alternateIconComponent?: Element

OptionaliconComponent

iconComponent?: Element

OptionalcustomComponent

customComponent?: Element

Optionalcolor

color?: string

OptionalactiveColor

activeColor?: string

OptionalinActiveColor

inActiveColor?: string

Optionaldisabled

disabled?: boolean

Optionalshow

show?: boolean

Optionalstyle

style?: CSSProperties

OptionalclassName

className?: string

OptionalbuttonProps

buttonProps?: ButtonHTMLAttributes<HTMLButtonElement>

OptionaliconWrapperProps

iconWrapperProps?: HTMLAttributes<HTMLSpanElement>

OptionaltextProps

textProps?: HTMLAttributes<HTMLSpanElement>

OptionalcontentWrapperProps

contentWrapperProps?: HTMLAttributes<HTMLDivElement>

OptionalrenderContent

renderContent?: ((options: {
    index: number;
    isActive: boolean;
    defaultIcon: ReactNode;
    defaultLabel: ReactNode;
    defaultContent: ReactNode;
    vertical: boolean;
}) => ReactNode)

Settings

Member Visibility

On This Page

Properties