Skip to main content
Version: 7.25.4

Overlay

Controls overlay options

const options = {
overlay: {
}
}

interceptTouchOutside#

Controls whether touch events outside the bounds of the overlay are to be handled by content behind the overlay. When set to true, touch events will not pass through to the underlying content.

TypeRequiredPlatform
booleanNoBoth

handleKeyboardEvents#

Overlays on iOS don't handle keyboard events by default. If your Overlay contains a TextInput component, you'll want to enable this option so that TextInput responds to keyboard events.

TypeRequiredPlatform
booleanNoiOS

attach#

Attach the overlay component as a tooltip for a given anchor view id, in a layer id (Z-Axis).

TypeRequiredPlatform
OverlayAttachOptionsNoBoth