‹ Bar buttons

Types

Types

The types of bar buttons.

SectionBar buttonsDraftDocumented, not reviewed yet: the API can change.

NavigationButton

Type

A button of the top bar or the toolbar, with what its press does.

type NavigationButton = Omit<OptionsTopBarButton, 'menu'> & {
  onPress?: ButtonPressHandler;
  menu?: NavigationButtonMenu;
}

Member	Type	Description
pinned	boolean	Whether a right button stays out of the overflow menu. On iOS 16+ it goes to the pinned group at the trailing edge, behind the overflow button, in a capsule of its own (several pinned buttons share it); when space runs out iOS hides the title first. On Android it stays in the bar while other right buttons move to the overflow when they don't fit. No effect on left and center buttons.
selected	boolean	Whether the button is drawn as switched on: on iOS 26 filled with its color, with the icon or text on it. For a toggle this is the starting state, and mergeOptions flips it from code. Works without toggle too. iOSiPadOSAndroid (not supported)
badgeColor	Color	(iOS 26+) The color of the badge. Without it, the system red.
fontFamily	FontFamily	The font family of the text. On iOS the font is built from all font options together, the size defaulting to 17.
fontStyle	FontStyle	The slant of the text.
fontWeight	FontWeight	The weight of the text.
fontSize	number	The size of the text: points on iOS (17 once any font option is set), sp on Android.
iconInsets	IconInsets	The space around the image of icon; the button becomes a button of its own, without a capsule with the glass design (iOS 26+, see UIDesignRequiresCompatibility). iOSiPadOSAndroid (not supported)
disableIconTint	boolean	Whether the icon keeps its own colors instead of being tinted. On iOS an SF Symbol stays multicolor and a side color from mergeOptions doesn't repaint it; on Android the icon gets no tint.
idRequired	string	The id of the button: the buttonId of its press, the key of the press handler, of a toggle's state and of a menu's choice, and the source of a popover (modal.popover.sourceButtonId). Required: a button without an id is not shown on either platform, the error goes to the log, and in development to a red box.
allCaps	boolean	Whether the text is drawn in capitals. Without it, as the theme says (not in capitals in Material 3). iOS (not supported)iPadOS (not supported)Android
icon	ImageResource	The icon: an image, or an icon for each platform ({ ios: 'SF Symbol', android: 'resource' }). A platform without its side shows no icon. On iOS an SF Symbol without a color is drawn as a template in the color of the bar and fades when disabled (disableIconTint keeps its own colors); an image is drawn as it is, tinted when a color is set. With a text, the text becomes the button's label: the bar shows only the icon, the overflow menu and the customization panel show the text. An image with iconBackground or iconInsets makes a button of its own. On Android the icon is a drawable resource of the app or an image source, tinted with color (disabledColor when disabled), or as it is without one. An icon that fails to load leaves the button without it, with its text if it has one, and reports the error to the log (in development, a red box).
component	OptionsTopBarButtonComponent	A React component as the button. The component handles its own touches: the bar sends no press for it, and menu, toggle and style have no effect. It is drawn before the screen shows.
systemItem	SystemItemIcon	The system button. Only 'close' works on Android. On the toolbar, spaces and the search field have objects of their own (OptionsToolbarSpace, OptionsToolbarSearchField).
text	string	The text of the button. A button with an icon keeps it as a label for the overflow menu, the customization panel and VoiceOver (iOS), or for TalkBack, the tooltip of a long press and the overflow menu (Android).
accessibilityLabel	string	The text a screen reader says for the button.
enabled	boolean	Whether the button reacts. A disabled button is dimmed (see disabledColor) and a press does nothing.
color	Color	The color of the text and of the icon; it beats the color of the side (leftButtonColor and the like). On iOS a 'prominent' button uses it only as the tint of its capsule.
disabledColor	Color	The color while the button is disabled; it beats the color of the side. Android defaults to light gray.
iconBackground	IconBackgroundOptions	A shape behind the icon. It works with an icon image and a color of the shape; on iOS the button becomes a button of its own without menu, toggle or style, and without a capsule with the glass design by default. The color of a whole side is leftButtonBackgroundColor / rightButtonBackgroundColor.
style	'plain' | 'prominent'	'plain' or 'prominent', the main action of the bar (Done, Send). With the glass design (iOS 26+, see UIDesignRequiresCompatibility) a prominent button is a capsule in the button's tint with bold text or icon on it (the tint is color, the bar's tint without it); without it, it is the system's done style with bold text. Not for component buttons, buttons with iconBackground, and showText buttons. iOSiPadOSAndroid (not supported)
testID	string	The identifier tests find the button by: the accessibility identifier on iOS, the resource id and the view tag on Android (in the bar and in the overflow menu). A component button puts it on its slot; the component sets its own inside.
hideSharedBackground	boolean	(iOS 26+, glass design) Whether the button has no glass capsule under it; neighbors keep theirs. By default true for component buttons and for icon buttons with a background or insets, false for the rest. In a group of several buttons the capsule is shared and this has no effect. A change by mergeOptions builds the buttons anew.
showText	boolean	Whether a button with an icon and a text shows both side by side, as one button on the bar's glass. The button is a view of its own; color, the side color, fonts, enabled, badge, group, testID and accessibilityLabel work, while menu, toggle, style and iconBackground don't. In the overflow menu it is an item with text and icon. For the bar and the toolbar. iOSiPadOSAndroid (not supported)
group	string	(iOS 26+, glass design) Buttons next to each other with the same group share one capsule; a button without a group has its own. Without the glass design it does nothing, on iOS 15 there are no groups. A side that has a group of several buttons doesn't animate button changes. The toolbar has no groups: only icons share a capsule there. For center buttons the group is a section of the overflow menu, and its name is the id the customization is saved under.
badge	number | string | boolean | null	(iOS 26+) A badge on the button: a number, a short text, or true for a dot. 0, '', false and null show none. mergeOptions changes it on the fly. The toolbar doesn't draw badges.
badgeTextColor	Color	(iOS 26+) The color of the number or text of the badge. Without it, white.
toggle	boolean	Whether the button is a toggle: every press flips selected and sends a press with the new state. The state stays with the screen under the button's id, through it showing again, a mergeOptions that sends the same buttons again and setDefaultOptions; a mergeOptions into the screen that changes selected replaces it (a merge into the stack around it doesn't). A button set again without selected takes the state of the button with the same id. Not for component buttons, buttons with iconBackground, and showText buttons. iOSiPadOSAndroid (not supported)
menuOnLongPress	boolean	Whether a press does the button's own action (a press event, a toggle) and the menu opens on a long press. Without it the menu opens on a press.
customization	'fixed' | 'movable' | 'optional'	(iOS 16+) For a center button, when topBar.customizationId is set: 'fixed' stays in place, 'movable' moves but can't be removed, 'optional' moves and can be removed and added back in the customization panel. A group moves as a whole. Renaming a group or a button resets the saved customization.
shownByDefault	boolean	(iOS 16+) Whether an 'optional' center button is in the bar before the user customizes it. With false the user adds it from the customization panel. On iPhone center buttons are in the overflow menu anyway.
priority	'high' | 'standard' | 'low'	Which buttons move to the overflow menu last: 'high' stays longest, 'low' goes first. On iOS 27+ it is the visibility priority of the button (it matters in the narrow vertical bar of iPhone Duo too); before iOS 27 it does nothing. On Android the bar keeps the right buttons of the highest priority, ties in list order.
vertical	boolean	(iOS 27.1+) Whether the button may move to the vertical bar of iPhone Duo: true allows it, a component button too, narrowed to the width of the bar; false keeps it in the horizontal row. Without it the system decides and a component button stays in the row.
onPress	ButtonPressHandler
menu	NavigationButtonMenu

Defined in src/api/options/buttons.ts ↗

ButtonPressHandler

Type

Called when the button is pressed. The function stays in JavaScript; the native side gets the button's id. It gets the navigation of its screen, so the options need no import: onPress: ({ navigation }) => navigation.openMenu('left').

type ButtonPressHandler = (event: ButtonPressEvent) => void

Defined in src/api/options/buttons.ts ↗

NavigationButtonMenu

Type

The menu of a button, whose items take onPress.

type NavigationButtonMenu = Omit<OptionsTopBarButtonMenu, 'items'> & {
  items: (NavigationMenuItem | NavigationSubmenu)[];
}

Member	Type	Description
title	string	The title above the items. (iOS) Android doesn't show it.
singleSelection	boolean	Whether only one item of the top level can be checked at a time: picking an item moves the check mark to it. On iOS this is the system's single-selection menu; on Android the items are checkable.
itemsRequired	(NavigationMenuItem | NavigationSubmenu)[]

Defined in src/api/options/buttons.ts ↗

NavigationMenuItem

Type

An item of a button menu, with what picking it does.

type NavigationMenuItem = OptionsTopBarButtonMenuItem & { onPress?: ButtonPressHandler }

Member	Type	Description
id	string	The id of the item, sent as buttonId when the item is picked. An item without an id sends nothing on iOS.
title	string	The text of the item. Without it the item shows an empty string.
icon	ImageResource	The icon in front of the text. On iOS an SF Symbol or an image; on Android a drawable resource or an image source. On Android the icons show in the menu as soon as one item has one, tinted like the menu's other icons (the error color for a destructive item). An icon that fails to load leaves the item without one.
destructive	boolean	Whether the item is drawn as a destructive action: red on both platforms.
disabled	boolean	Whether the item is shown but can't be picked.
checked	boolean	Whether the item carries a check mark. On Android the item is checkable, also outside a singleSelection menu. With singleSelection on the menu, picking an item moves the mark to it, and mergeOptions with checked moves it from code.
testID	string	The identifier tests find the item by: the accessibility identifier on iOS, the resource id and view tag of the item on Android. Where the system gives no way to set it, the item is found by its text.
onPress	ButtonPressHandler

Defined in src/api/options/buttons.ts ↗

NavigationSubmenu

Type

A submenu of a button menu.

type NavigationSubmenu = Omit<OptionsTopBarButtonSubmenu, 'items'> & {
  items: (NavigationMenuItem | NavigationSubmenu)[];
}

Member	Type	Description
icon	ImageResource	The icon of the submenu item, as for a menu item.
testID	string	The identifier tests find the submenu item by, as for a menu item.
title	string	The text of the submenu item. Without it the item shows an empty string.
singleSelection	boolean	Whether only one item of this submenu can be checked at a time.
itemsRequired	(NavigationMenuItem | NavigationSubmenu)[]

Defined in src/api/options/buttons.ts ↗

OptionsTopBarButton

Interface

A button of the top bar (leftButtons, rightButtons, centerButtons) or of the toolbar (toolbar.buttons). The kinds are picked by the fields that are set. On iOS, the first that fits wins: a component, then an icon with text and showText, then an icon with iconBackground or iconInsets, then an SF Symbol, an image icon, a text, a systemItem; a button with none of them is not shown. On Android a button is a button of the bar's row: text, icon or a component. Lists of buttons are replaced as a whole and take nothing from the lists of lower layers.

Text, icon, color and similar fields are the same in all four places; where a place or a side differs, the field says so.

interface OptionsTopBarButton

Member	Type	Description
idRequired	string	The id of the button: the buttonId of its press, the key of the press handler, of a toggle's state and of a menu's choice, and the source of a popover (modal.popover.sourceButtonId). Required: a button without an id is not shown on either platform, the error goes to the log, and in development to a red box.
allCaps	boolean	Whether the text is drawn in capitals. Without it, as the theme says (not in capitals in Material 3). iOS (not supported)iPadOS (not supported)Android
icon	ImageResource	The icon: an image, or an icon for each platform ({ ios: 'SF Symbol', android: 'resource' }). A platform without its side shows no icon. On iOS an SF Symbol without a color is drawn as a template in the color of the bar and fades when disabled (disableIconTint keeps its own colors); an image is drawn as it is, tinted when a color is set. With a text, the text becomes the button's label: the bar shows only the icon, the overflow menu and the customization panel show the text. An image with iconBackground or iconInsets makes a button of its own. On Android the icon is a drawable resource of the app or an image source, tinted with color (disabledColor when disabled), or as it is without one. An icon that fails to load leaves the button without it, with its text if it has one, and reports the error to the log (in development, a red box).
iconInsets	IconInsets	The space around the image of icon; the button becomes a button of its own, without a capsule with the glass design (iOS 26+, see UIDesignRequiresCompatibility). iOSiPadOSAndroid (not supported)
component	OptionsTopBarButtonComponent	A React component as the button. The component handles its own touches: the bar sends no press for it, and menu, toggle and style have no effect. It is drawn before the screen shows.
systemItem	SystemItemIcon	The system button. Only 'close' works on Android. On the toolbar, spaces and the search field have objects of their own (OptionsToolbarSpace, OptionsToolbarSearchField).
text	string	The text of the button. A button with an icon keeps it as a label for the overflow menu, the customization panel and VoiceOver (iOS), or for TalkBack, the tooltip of a long press and the overflow menu (Android).
accessibilityLabel	string	The text a screen reader says for the button.
fontFamily	FontFamily	The font family of the text. On iOS the font is built from all font options together, the size defaulting to 17.
fontStyle	FontStyle	The slant of the text.
fontWeight	FontWeight	The weight of the text.
fontSize	number	The size of the text: points on iOS (17 once any font option is set), sp on Android.
enabled	boolean	Whether the button reacts. A disabled button is dimmed (see disabledColor) and a press does nothing.
disableIconTint	boolean	Whether the icon keeps its own colors instead of being tinted. On iOS an SF Symbol stays multicolor and a side color from mergeOptions doesn't repaint it; on Android the icon gets no tint.
color	Color	The color of the text and of the icon; it beats the color of the side (leftButtonColor and the like). On iOS a 'prominent' button uses it only as the tint of its capsule.
disabledColor	Color	The color while the button is disabled; it beats the color of the side. Android defaults to light gray.
iconBackground	IconBackgroundOptions	A shape behind the icon. It works with an icon image and a color of the shape; on iOS the button becomes a button of its own without menu, toggle or style, and without a capsule with the glass design by default. The color of a whole side is leftButtonBackgroundColor / rightButtonBackgroundColor.
style	'plain' | 'prominent'	'plain' or 'prominent', the main action of the bar (Done, Send). With the glass design (iOS 26+, see UIDesignRequiresCompatibility) a prominent button is a capsule in the button's tint with bold text or icon on it (the tint is color, the bar's tint without it); without it, it is the system's done style with bold text. Not for component buttons, buttons with iconBackground, and showText buttons. iOSiPadOSAndroid (not supported)
testID	string	The identifier tests find the button by: the accessibility identifier on iOS, the resource id and the view tag on Android (in the bar and in the overflow menu). A component button puts it on its slot; the component sets its own inside.
hideSharedBackground	boolean	(iOS 26+, glass design) Whether the button has no glass capsule under it; neighbors keep theirs. By default true for component buttons and for icon buttons with a background or insets, false for the rest. In a group of several buttons the capsule is shared and this has no effect. A change by mergeOptions builds the buttons anew.
showText	boolean	Whether a button with an icon and a text shows both side by side, as one button on the bar's glass. The button is a view of its own; color, the side color, fonts, enabled, badge, group, testID and accessibilityLabel work, while menu, toggle, style and iconBackground don't. In the overflow menu it is an item with text and icon. For the bar and the toolbar. iOSiPadOSAndroid (not supported)
group	string	(iOS 26+, glass design) Buttons next to each other with the same group share one capsule; a button without a group has its own. Without the glass design it does nothing, on iOS 15 there are no groups. A side that has a group of several buttons doesn't animate button changes. The toolbar has no groups: only icons share a capsule there. For center buttons the group is a section of the overflow menu, and its name is the id the customization is saved under.
badge	number | string | boolean | null	(iOS 26+) A badge on the button: a number, a short text, or true for a dot. 0, '', false and null show none. mergeOptions changes it on the fly. The toolbar doesn't draw badges.
badgeColor	Color	(iOS 26+) The color of the badge. Without it, the system red.
badgeTextColor	Color	(iOS 26+) The color of the number or text of the badge. Without it, white.
toggle	boolean	Whether the button is a toggle: every press flips selected and sends a press with the new state. The state stays with the screen under the button's id, through it showing again, a mergeOptions that sends the same buttons again and setDefaultOptions; a mergeOptions into the screen that changes selected replaces it (a merge into the stack around it doesn't). A button set again without selected takes the state of the button with the same id. Not for component buttons, buttons with iconBackground, and showText buttons. iOSiPadOSAndroid (not supported)
selected	boolean	Whether the button is drawn as switched on: on iOS 26 filled with its color, with the icon or text on it. For a toggle this is the starting state, and mergeOptions flips it from code. Works without toggle too. iOSiPadOSAndroid (not supported)
menu	OptionsTopBarButtonMenu	The menu of the button. It opens on a press, or on a long press with menuOnLongPress. A pick sends a press with the id of the item. On iOS it is the system menu (on the toolbar it opens upward), not for component buttons and buttons with iconBackground; on Android a popup under the button without a title (from the end of the bar for a button in the overflow), not for component buttons.
menuOnLongPress	boolean	Whether a press does the button's own action (a press event, a toggle) and the menu opens on a long press. Without it the menu opens on a press.
customization	'fixed' | 'movable' | 'optional'	(iOS 16+) For a center button, when topBar.customizationId is set: 'fixed' stays in place, 'movable' moves but can't be removed, 'optional' moves and can be removed and added back in the customization panel. A group moves as a whole. Renaming a group or a button resets the saved customization.
shownByDefault	boolean	(iOS 16+) Whether an 'optional' center button is in the bar before the user customizes it. With false the user adds it from the customization panel. On iPhone center buttons are in the overflow menu anyway.
pinned	boolean	Whether a right button stays out of the overflow menu. On iOS 16+ it goes to the pinned group at the trailing edge, behind the overflow button, in a capsule of its own (several pinned buttons share it); when space runs out iOS hides the title first. On Android it stays in the bar while other right buttons move to the overflow when they don't fit. No effect on left and center buttons.
priority	'high' | 'standard' | 'low'	Which buttons move to the overflow menu last: 'high' stays longest, 'low' goes first. On iOS 27+ it is the visibility priority of the button (it matters in the narrow vertical bar of iPhone Duo too); before iOS 27 it does nothing. On Android the bar keeps the right buttons of the highest priority, ties in list order.
vertical	boolean	(iOS 27.1+) Whether the button may move to the vertical bar of iPhone Duo: true allows it, a component button too, narrowed to the width of the bar; false keeps it in the horizontal row. Without it the system decides and a component button stays in the row.

Defined in src/interfaces/options/buttons.ts ↗

OptionsTopBarButtonMenu

Interface

A menu of the top bar: the menu of a button, the overflow menu, the menu of the title. A list of items sent with mergeOptions replaces the earlier list as a whole, and items: [] removes the menu; title and singleSelection merge field by field (iOS). What the user picks in a singleSelection menu stays with the screen, through it showing again, a mergeOptions that sends the same items again and setDefaultOptions; a mergeOptions into the screen that changes the checks of that menu's level, or takes the item away, replaces it. A merge into the stack or the tabs around the screen doesn't.

interface OptionsTopBarButtonMenu

Member	Type	Description
title	string	The title above the items. (iOS) Android doesn't show it.
singleSelection	boolean	Whether only one item of the top level can be checked at a time: picking an item moves the check mark to it. On iOS this is the system's single-selection menu; on Android the items are checkable.
items	OptionsTopBarButtonMenuElement[]	The items and submenus, in order. An empty list removes the menu.

Defined in src/interfaces/options/buttons.ts ↗

OptionsTopBarButtonMenuItem

Interface

An item of a menu. Picking it sends a button press with its id to the screen, and the screen runs the onPress of the item that has this id. Item ids and button ids of one screen must not repeat.

interface OptionsTopBarButtonMenuItem

Member	Type	Description
id	string	The id of the item, sent as buttonId when the item is picked. An item without an id sends nothing on iOS.
title	string	The text of the item. Without it the item shows an empty string.
icon	ImageResource	The icon in front of the text. On iOS an SF Symbol or an image; on Android a drawable resource or an image source. On Android the icons show in the menu as soon as one item has one, tinted like the menu's other icons (the error color for a destructive item). An icon that fails to load leaves the item without one.
destructive	boolean	Whether the item is drawn as a destructive action: red on both platforms.
disabled	boolean	Whether the item is shown but can't be picked.
checked	boolean	Whether the item carries a check mark. On Android the item is checkable, also outside a singleSelection menu. With singleSelection on the menu, picking an item moves the mark to it, and mergeOptions with checked moves it from code.
testID	string	The identifier tests find the item by: the accessibility identifier on iOS, the resource id and view tag of the item on Android. Where the system gives no way to set it, the item is found by its text.

Defined in src/interfaces/options/buttons.ts ↗

OptionsTopBarButtonSubmenu

Interface

A submenu: an item that opens a menu of its own, of any depth. Submenus carry no check mark.

interface OptionsTopBarButtonSubmenu

Member	Type	Description
title	string	The text of the submenu item. Without it the item shows an empty string.
icon	ImageResource	The icon of the submenu item, as for a menu item.
singleSelection	boolean	Whether only one item of this submenu can be checked at a time.
itemsRequired	OptionsTopBarButtonMenuElement[]	The items and submenus, in order.
testID	string	The identifier tests find the submenu item by, as for a menu item.

Defined in src/interfaces/options/buttons.ts ↗

OptionsTopBarButtonMenuElement

Type

An item or a submenu of a menu. An element with items is a submenu.

type OptionsTopBarButtonMenuElement =
  OptionsTopBarButtonMenuItem | OptionsTopBarButtonSubmenu

Member	Type	Description
id	string	The id of the item, sent as buttonId when the item is picked. An item without an id sends nothing on iOS.
title	string	The text of the item. Without it the item shows an empty string.
icon	ImageResource	The icon in front of the text. On iOS an SF Symbol or an image; on Android a drawable resource or an image source. On Android the icons show in the menu as soon as one item has one, tinted like the menu's other icons (the error color for a destructive item). An icon that fails to load leaves the item without one.
destructive	boolean	Whether the item is drawn as a destructive action: red on both platforms.
disabled	boolean	Whether the item is shown but can't be picked.
checked	boolean	Whether the item carries a check mark. On Android the item is checkable, also outside a singleSelection menu. With singleSelection on the menu, picking an item moves the mark to it, and mergeOptions with checked moves it from code.
testID	string	The identifier tests find the item by: the accessibility identifier on iOS, the resource id and view tag of the item on Android. Where the system gives no way to set it, the item is found by its text.
singleSelection	boolean	Whether only one item of this submenu can be checked at a time.
itemsRequired	OptionsTopBarButtonMenuElement[]	The items and submenus, in order.

Defined in src/interfaces/options/buttons.ts ↗

SystemItemIcon

Type

The system button a button shows. On iOS it is the system item of the same name, with the text of the user's language; a name the system doesn't know shows 'done'. On Android only 'close' is read: it draws the library's close icon when the button has no icon of its own, and every other name is ignored.

type SystemItemIcon =
  | 'done'
  | 'cancel'
  | 'edit'
  | 'save'
  | 'add'
  | 'flexibleSpace'
  | 'fixedSpace'
  | 'compose'
  | 'reply'
  | 'action'
  | 'organize'
  | 'bookmarks'
  | 'search'
  | 'refresh'
  | 'stop'
  | 'camera'
  | 'trash'
  | 'play'
  | 'pause'
  | 'rewind'
  | 'fastForward'
  | 'undo'
  | 'redo'
  | 'close'

Defined in src/interfaces/options/buttons.ts ↗

IconInsets

Interface

The space around the image of an icon, in points.

interface IconInsets

Member	Type	Description
top	number	The space above the image, in points.
left	number	The space left of the image, in points.
bottom	number	The space below the image, in points.
right	number	The space right of the image, in points.

Defined in src/interfaces/options/buttons.ts ↗

IconBackgroundOptions

Interface

A filled shape behind the icon of a button or of the back button. It takes effect only when color is set; without a color the other fields are ignored.

On iOS the icon is drawn onto the shape and the button becomes a button of its own (the back button keeps its history menu), without the glass capsule (glass design, iOS 26+) by default. On Android the icon sits on the shape, mirrored in a right-to-left layout. Layers merge differently: on iOS an object merges field by field like any other, on Android an iconBackground that has a color replaces the earlier one as a whole.

interface IconBackgroundOptions

Member	Type	Description
color	Color	The color of the shape. Without it the whole iconBackground has no effect.
disabledColor	Color	The color of the shape while the button is disabled. Without it the shape keeps color on iOS and disappears on Android. The back button is never disabled, so it ignores this field.
cornerRadius	number	The radius of the corners of the shape, in points (iOS) or dp (Android).
width	number	The width of the shape, in points or dp. By default the width of the icon; on Android never less than that.
height	number	The height of the shape, in points or dp. By default the height of the icon; on Android never less than that.

Defined in src/interfaces/options/buttons.ts ↗

ButtonPressEvent

Type

A press of a button or of an item of its menu, with the navigation of the screen whose button it is.

type ButtonPressEvent = ButtonPressedEvent & { navigation: ScreenNavigation }

Member	Type	Description
selected	boolean	For a button with toggle: its new state, which the screen keeps. iOSiPadOSAndroid (not supported)
buttonIdRequired	string	The id of the button or of the menu item. The back button has the id set in topBar.backButton.id, or ApexNavigation.back; the hardware back of a modal has ApexNavigation.hardwareBackButton.
screenRequired	ScreenRef
navigationRequired	ScreenNavigation

Defined in src/api/options/buttons.ts ↗

ButtonPressedEvent

Type

type ButtonPressedEvent = NavigationEvents['buttonPressed']

Member	Type	Description
selected	boolean	For a button with toggle: its new state, which the screen keeps. iOSiPadOSAndroid (not supported)
buttonIdRequired	string	The id of the button or of the menu item. The back button has the id set in topBar.backButton.id, or ApexNavigation.back; the hardware back of a modal has ApexNavigation.hardwareBackButton.
screenRequired	ScreenRef

Defined in src/api/events/navigationEvents.ts ↗