Skip to main content
‹ Overlays
Options

overlay

A screen shown as an overlay: whether touches outside its content go through to what is below.

SectionOverlaysDraftDocumented, 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.

2 options shown

interceptTouchOutsideboolean= false

Whether the overlay keeps the touches that land outside its own views. With false those touches reach the app under the overlay; with true they stop at the overlay. A touch counts as inside when it lands on a view of the content that takes touches, so a full-screen wrapper with pointerEvents="box-none" lets touches through. A dialog with a dimmed background gets the touches on the background by being a view of its own.

iOSiPadOSAndroid
testIDstring

The test identifier of the overlay's container: on iOS the root view of the overlay's window, on Android the overlay's view in the layer of overlays. The content of the screen has its own testID.

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