Skip to main content
Version: 7.25.4

Overlay

showOverlay()#

Shows a component as an overlay.

NameRequiredTypeDescription
layoutYesLayoutAny type of layout. Typically, Component layout is used in Overlays but it's possible to load any other layout (BottomTabs, Stack, SideMenu, Component)
Navigation.showOverlay({
component: {
name: 'example.Overlay',
options: {
layout: {
componentBackgroundColor: 'transparent',
},
overlay: {
interceptTouchOutside: true
}
}
}
});

dismissOverlay()#

Dismisses an overlay matching the given overlay componentId.

Parameters#

NameRequiredTypeDescription
componentIdYesstringThe component id presented in Overlay
Navigation.dismissOverlay(this.props.componentId);

dismissAllOverlays()#

Dismisses all overlays.

Navigation.dismissAllOverlays();