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

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

barStyle

Control the TopBar blur style. Requires translucent: true.

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

borderColor

Change the topBar border color.

TypeRequiredPlatform
ColorNoiOS

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

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.

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

Shows the UISearchBar in the TopBar.

TypeRequiredPlatform
booleanNoiOS 11+

searchBarHiddenWhenScrolling

Hides the UISearchBar when scrolling.

TypeRequiredPlatform
booleanNoiOS 11+

searchBarPlaceholder

The placeholder value in the UISearchBar.

TypeRequiredPlatform
stringNoiOS 11+