Type alias ToolbarButton

ToolbarButton: {
    alignItem?: "left" | "right" | "center";
    disabled?: boolean;
    icon?: CarbonIcon;
    onLongPress?: ((event) => void);
    onPress?: ((event) => void);
    style?: StyleProp<ViewStyle>;
    text: string;
    textType?: TextTypes;
}

Represents a toolbar button for all navigation components and flows.

Type declaration

  • Optional alignItem?: "left" | "right" | "center"

    Alignment (defaults to center)

  • Optional disabled?: boolean

    Indicate if toolbar item is disabled

  • Optional icon?: CarbonIcon

    Icon to use for toolbar item (size 20)

  • Optional onLongPress?: ((event) => void)
      • (event): void

      • onLongPress event for toolbar item

        Parameters

        • event: GestureResponderEvent

        Returns void

  • Optional onPress?: ((event) => void)
      • (event): void

      • onPress event for toolbar item

        Parameters

        • event: GestureResponderEvent

        Returns void

  • Optional style?: StyleProp<ViewStyle>

    Style to set on the item

  • text: string

    Text to use for label of toolbar item. When used with icon is not shown and used for accessibility only.

  • Optional textType?: TextTypes

    Text type to render (Standard is default)

Settings

Member Visibility

Theme

Generated using TypeDoc