MediaSFU React Native
    Preparing search index...

    Interface Button

    Button descriptor used by ControlButtonsComponent.

    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;
    }
    Index

    Properties

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

    Properties

    name?: string

    Optional label displayed beneath the icon.

    icon?: string

    Default FontAwesome5 icon name when inactive.

    alternateIcon?: string

    Icon displayed when the button is active.

    onPress?: () => void

    Handler invoked when the button is pressed.

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

    Background colors for idle and pressed states.

    active?: boolean

    Enables alternate icon or color states.

    alternateIconComponent?: Element

    Custom component rendered when active.

    iconComponent?: Element

    Custom component rendered when inactive.

    customComponent?: Element

    Full override replacing icon and label.

    color?: string

    Default text/icon color for the button.

    activeColor?: string

    Icon color when the button is active.

    inActiveColor?: string

    Icon color when the button is inactive.

    disabled?: boolean

    Disables press interactions.

    show?: boolean

    Toggle to hide the button entirely when false.

    Settings

    Member Visibility

    On This Page

    Properties