Skip to main content
Version: 7.25.4

Back Button Options

Controls the back button styling.

const options = {
topBar: {
backButton: {},
},
};

accessibilityLabel#

Overrides the text that's read by the screen reader when the user interacts with the back button.

TypeRequiredPlatform
stringNoAndroid

id#

Button id for reference press event.

TypeRequiredPlatform
stringNoAndroid

color#

Change the back button color. This will change the text color as well.

TypeRequiredPlatform
colorNoBoth

icon#

Change the default back button icon.

TypeRequiredPlatform
ImageResourceNoBoth

sfSymbol#

SF Symbol to show as the back button

TypeRequiredPlatform
stringNoiOS 13+

showTitle#

Show or hide the text displayed next to the back button.

TypeRequiredPlatform
numberNoiOS

displayMode#

Set display mode of the back button. Currently works for iOS 14+ only. See: UINavigationItem.BackButtonDisplayMode

TypeRequiredPlatform
enum('default', 'generic', 'minimal')NoiOS

title#

Change the text displayed next to the title. Usually the back button shows the title of the previous screen.

TypeRequiredPlatform
stringNoiOS

visible#

Hide or show the back button.

TypeRequiredPlatform
booleanNoBoth

testID#

Used to interact with the back button in e2e tests.

TypeRequiredPlatform
stringNoBoth

enableMenu#

Enables iOS 14 back button menu display.

TypeRequiredPlatformDefault
booleanNoiOStrue

popStackOnPress#

Controls whether the default back button should pop screen or not.

TypeRequiredDefault
booleanNotrue