Skip to content

Files

Latest commit

 

History

History
173 lines (118 loc) · 5.44 KB

options-root.mdx

File metadata and controls

173 lines (118 loc) · 5.44 KB
id title sidebar_label
options-root
The options object
Options object
 
const options = {
  bottomTab,
  bottomTabs,
  topBar,
  layout,
  sideMenu,
  overlay,
  modal,
  preview,
  navigationBar
};

bottomTab

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

Type Required Platform
BottomTabOptions No Both

bottomTabs

Controls the bottom tabs container.

Type Required Platform
BottomTabsOptions No Both

topBar

Controls the Stack top bar styling.

Type Required Platform
TopBarOptions No

statusBar

Controls the system status bar styling.

Type Required Platform
StatusBarOptions No Both

layout

Type Required Platform
LayoutOptions No Both

sideMenu

Type Required Platform
SideMenuOptions No Both

overlay

Type Required Platform
OverlayOptions No Both

animations

Type Required Platform
AnimationsOptions No Both

modal

Type Required Platform
ModalOptions No Both

preview

Type Required Platform
PreviewOptions No iOS

splitView

Type Required Platform
SplitViewOptions No iOS

fab

Type Required Platform
Fab No Android

modalPresentationStyle

Configure the presentation style of the modal.

Type Required Platform
enum('formSheet', 'pageSheet', 'fullScreen', 'overFullScreen', 'overCurrentContext', 'popOver', 'none') No Both

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.

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

modalTransitionStyle

Configure the transition style of the modal.

Type Required Platform
enum('coverVertical', 'crossDissolve', 'flipHorizontal', 'partialCurl') No Both

popGesture

Enable or disable swipe back to pop gesture.

Type Required Platform
boolean No iOS

backgroundImage

Background image of the screen.

Type Required Platform
Image No iOS

rootBackgroundImage

Background image for the Navigation View.

Type Required Platform
Image No Android

blurOnUnmount

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

Type Required Platform Default
boolean No Android false

navigationBar

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

Type Required Platform
boolean No Android