‹ Side menu

Options

sideMenu

The side menus of the side menu the screen is in: their visibility, width, gestures.

SectionSide menuDraftDocumented, not reviewed yet: the API can change.

Options

Every key, with the platforms it works on. A dashed platform means the key does nothing there.

Filter options

Deprecated

6 options shown

leftSideMenuSide

The left menu.

Type: SideMenuSide ›

iOSiPadOSAndroid

rightSideMenuSide

The right menu.

Type: SideMenuSide ›

iOSiPadOSAndroid

openGestureModeSideMenuOpenGestureMode= 'bezel'

Where a swipe has to start to open a menu. Closing by a gesture works from anywhere in both modes, and the swipe back of a stack goes before the menu: on a screen that can go back, the leading edge goes back and doesn't open a menu. In 'entireScreen' mode a horizontal scroll in the center goes first while it can still scroll in the direction of the move; a horizontal pan that isn't a native scroll view, such as a carousel of a gesture library, doesn't. A change applies at once. Android's edge is the one of the Material drawer, and it doesn't read this.

iOSiPadOSAndroid (not supported)Showcase 10.1 ›

animationTypeSideMenuAnimationType

How the menu moves in 'pushContent' mode while the center goes aside. Without it, the menu stands still and the center moves. It does nothing in 'aboveContent' mode. A change applies at once. Android doesn't read it.

iOSiPadOSAndroid (not supported)Showcase 10.2 ›

menusAttachModeSideMenuAttachMode= 'together'

When the screens of the menus are created, together with their React content: 'together' creates them with the center; 'afterCenter' creates them right after the center first appears, so they don't compete with its first render and still show at once on the first open; 'onOpen' creates a menu the first time it starts to open — from a swipe, from visible: true or from visible in the layout — and until React draws its screen the menu shows its background. A command to a screen of a menu not created yet works: a push into its stack and mergeOptions wait for the menu like a tab not yet selected. The screens of a menu get appear events only when it opens, in every mode. With appProvider the screens render in the app's React tree at once in every mode, and the mode delays only their native containers. On iOS a menu's test identifier (<testID>.left, <testID>.right) is there once the menu is created; on Android from the start. It applies when the side menu is created, from its own options or the default options; mergeOptions does not change it.

iOSiPadOSAndroidShowcase 10.1 ›

testIDstring

The test identifier of the side menu's container (on iOS its view, on Android the drawer). The parts derive from it: <testID>.center, <testID>.left, <testID>.right, and on iOS <testID>.scrim for the dimming over the center that a tap on closes the menu. Android draws the dimming inside the drawer without a view of its own, and a tap on <testID>.center closes the menu in the same way. The button that opens the menu is an ordinary button of the top bar with a testID of its own.

iOSiPadOSAndroid

Generated from the types and their comments. Edit the source ↗