Type alias NavigationButton

NavigationButton: {
    active?: boolean;
    componentProps?: PressableProps;
    disabled?: boolean;
    icon: CarbonIcon;
    onLongPress?: ((event) => void);
    onPress?: ((event) => void);
    style?: StyleProp<ViewStyle>;
    text: string;
}

Represents a navigation button for all navigation components and flows.

Type declaration

  • Optional active?: boolean

    Indicate if navigatioin item is active

  • Optional componentProps?: PressableProps

    Direct props to set on the React Native component (including iOS and Android specific props). Most use cases should not need this.

  • Optional disabled?: boolean

    Indicate if navigation item is disabled

  • icon: CarbonIcon

    Icon to use for navigation item (size 20)

  • Optional onLongPress?: ((event) => void)
      • (event): void
      • onLongPress event for navigation item

        Parameters

        • event: GestureResponderEvent

        Returns void

  • Optional onPress?: ((event) => void)
      • (event): void
      • onPress event for navigation item

        Parameters

        • event: GestureResponderEvent

        Returns void

  • Optional style?: StyleProp<ViewStyle>

    Style to set on the item

  • text: string

    Text to use for label of navigation item

Generated using TypeDoc