The options object

const options = {
bottomTab,
bottomTabs,
topBar,
layout,
sideMenu,
overlay,
modal,
preview,
navigationBar
};

bottomTab

Controls the bottom tab icon, font, color, and more.

TypeRequiredPlatform
BottomTabOptionsNoBoth

bottomTabs

Controls the bottom tabs container.

TypeRequiredPlatform
BottomTabsOptionsNoBoth

topBar

Controls the Stack top bar styling.

TypeRequiredPlatform
TopBarOptionsNo

statusBar

Controls the system status bar styling.

TypeRequiredPlatform
StatusBarOptionsNoBoth

layout

TypeRequiredPlatform
LayoutOptionsNoBoth

sideMenu

TypeRequiredPlatform
SideMenuOptionsNoBoth

overlay

TypeRequiredPlatform
OverlayOptionsNoBoth

animations

TypeRequiredPlatform
AnimationsOptionsNoBoth

modal

TypeRequiredPlatform
ModalOptionsNoBoth

preview

TypeRequiredPlatform
PreviewOptionsNoiOS

splitView

TypeRequiredPlatform
SplitViewOptionsNoiOS

fab

TypeRequiredPlatform
FabNoAndroid

modalPresentationStyle

Configure the presentation style of the modal.

TypeRequiredPlatform
enum('formSheet', 'pageSheet', 'fullScreen', 'overFullScreen', 'overCurrentContext', 'popOver', 'none')NoBoth

Styles supported on both platforms

  • overCurrentContext - Display the modal and do not remove previous content when the show animation ends.
  • none - default system presentation style

Styles supported only on iOS

  • fullScreen - The view covers the underlying content completely.
  • pageSheet - partially cover the underlying content.
  • formSheet - display content centered in the screen.
  • overFullScreen - display the modal in full screen mode and do not remove previous content when the show animation ends.
  • popOver - Center content on screen and dim the content behind it.

The default presentation style is different on each platform.

iOSAndroid
  • iOS 12 and below - fullScreen
  • iOS 13 and above - pageSheet
fullScreen

modalTransitionStyle

Configure the transition style of the modal.

TypeRequiredPlatform
enum('coverVertical', 'crossDissolve', 'flipHorizontal', 'partialCurl')NoBoth

popGesture

Enable or disable swipe back to pop gesture.

TypeRequiredPlatform
booleanNoiOS

backgroundImage

Background image of the screen.

TypeRequiredPlatform
ImageNoiOS

rootBackgroundImage

Background image for the Navigation View.

TypeRequiredPlatform
ImageNoAndroid

blurOnUnmount

Enable or disable automaticall blur of the focused input, dismissing keyboard on unmount.

TypeRequiredPlatformDefault
booleanNoAndroidfalse

navigationBar

Enable or disable automaticall blur of the focused input, dismissing keyboard on unmount.

TypeRequiredPlatform
booleanNoAndroid