Overlay

The Overlay is a view that floats above an app’s content.

Overlays are an easy way to inform or request information from the user.

Usage

---

Web-platform specific note:

You must pass a valid React Native Modal component implementation into ModalComponent prop because Modal component is not implemented yet in react-native-web

...
import Modal from 'modal-react-native-web';

...

<Overlay ModalComponent={Modal} ... />
...

---

Props

Overlay

• ModalComponent
• backdropStyle
• fullScreen
• isVisible
• onBackdropPress
• overlayStyle
• pressableProps

Reference

Overlay

ModalComponent

Override React Native Modal component (usable for web-platform).

Type	Default
any	None

---

backdropStyle

Style of the backdrop container.

Type	Default
View style(Object)	None

---

fullScreen

If set to true, the modal will take up the entire screen width and height.

Type	Default
boolean	false

---

isVisible

If true, the overlay is visible.

Type	Default
boolean	None

---

onBackdropPress

Handler for backdrop press (only works when fullscreen is false).

Type	Default
Function	Function

---

overlayStyle

Style of the actual overlay.

Type	Default
View style(Object)	None

---

pressableProps

Type	Default
Omit<PressableProps, "onPress" or "onLongPress" or "onPressIn" or "onPressOut">	None

---