Skip to main content
Version: Next

Top Bar Options

TopBar#

const options = {
topBar: {
animate: true,
title: {},
subtitle: {},
backButton: {},
background: {},
},
};

visible#

Determines if TopBar is visible or not.

TypeRequiredPlatform
booleanNoBoth

animate#

Determines if changing the TopBar visibility will be animated or not.

TypeRequiredPlatform
booleanNoBoth

animateLeftButtons#

Determines if changing the left buttons will be animated.

TypeRequiredPlatformDefault
booleanNoBothFalse

animateRightButtons#

Determines if changing the right buttons will be animated.

TypeRequiredPlatformDefault
booleanNoBothFalse

title#

Controls the top bar title.

TypeRequiredPlatform
TitleNoBoth

subtitle#

Controls the top bar subtitle.

TypeRequiredPlatform
SubitleNoBoth

backButton#

Controls the top bar back button.

TypeRequiredPlatform
BackButtonNoBoth

background#

Controls the top bar background.

TypeRequiredPlatform
BackgroundNoBoth

scrollEdgeAppearance#

Controls the appearance settings when the scrollable content reaches the matching edge of the navigation bar.

TypeRequiredPlatform
Scroll Edge BackgroundNoiOS 13+

barStyle#

Control the TopBar blur style. Requires translucent: true.

TypeRequiredPlatform
enum('default','black')NoiOS

height#

Set TopBar height, in dp units, on Android only. For iOS use largeTitle see Options.

TypeRequiredPlatform
numberNoAndroid

borderColor#

Change the topBar border color.

TypeRequiredPlatform
ColorNoBoth

borderHeight#

Set the border height of the navbar in dp.

TypeRequiredPlatform
numberNoAndroid

drawBehind#

Controls if child should be drawn behind the TopBar or below it.

TypeRequiredPlatform
booleanNoBoth

elevation#

Set the elevation of the TopBar in dp. This option changes how the shadow under the TopBar looks. Setting this value to 0 will remove the shadow completely.

TypeRequiredPlatform
numberNoAndroid

hideOnScroll#

Hide the TopBar when a scrolling layout is scrolled.

TypeRequiredPlatform
booleanNoBoth
Deprecation warning

This option is currently deprecated and will be removed in a future release. Please use the OptionsSearchBar option instead.

hideNavBarOnFocusSearchBar#

Indicates whether the navigation bar should be hidden when searching. True by default.

TypeRequiredPlatform
booleanNoiOS 11+

leftButtons#

An array of buttons to be displayed at the right-side of the TopBar. Button layout is from left to right. See the Buttons section for more details.

Android support

Android currently only supports a single left button and does not support custom left Buttons.

TypeRequiredPlatform
[Button]NoBoth

leftButtonColor#

Default color for left buttons.

TypeRequiredPlatform
ColorNoBoth

noBorder#

Disables border at the bottom of the TopBar.

important

For disabling the border completely, you also need to disable scrollEdgeAppearance.noBorder

TypeRequiredPlatform
booleanNoiOS

rightButtons#

An array of buttons to be displayed at the right side of the TopBar. Button layout is from right to left. See the Buttons section for more details.

TypeRequiredPlatform
[Button]NoBoth

rightButtonColor#

Default color for the right button.

TypeRequiredPlatform
ColorNoBoth

searchBar#

Controls the SearchBar.

TypeRequiredPlatform
OptionsSearchBarNoiOS 11+
Deprecation warning

This option is currently deprecated and will be removed in a future release. Please use the OptionsSearchBar option instead.

searchBarHiddenWhenScrolling#

Hides the UISearchBar when scrolling.

TypeRequiredPlatform
booleanNoiOS 11+
Deprecation warning

This option is currently deprecated and will be removed in a future release. Please use the OptionsSearchBar option instead.

searchBarPlaceholder#

The placeholder value in the UISearchBar.

TypeRequiredPlatform
stringNoiOS 11+
Deprecation warning

This option is currently deprecated and will be removed in a future release. Please use the OptionsSearchBar option instead.

searchBarBackgroundColor#

The background color of the UISearchBar's TextField.

TypeRequiredPlatform
ColorNoiOS 13+
Deprecation warning

This option is currently deprecated and will be removed in a future release. Please use the OptionsSearchBar option instead.

searchBarTintColor#

The tint color of the UISearchBar. Affects text selection color, as well as "Cancel" button color.

TypeRequiredPlatform
ColorNoiOS 13+