React Navigation Overlay

This library attempts to add support for "Overlays" to React Navigation similar to the showOverlay API in React Native Navigation.

Install

npm i @qeepsake/react-navigation-overlay

Usage

Add the ReactNavigationOverlay component to the top of your tree inside your NavigationContainer. This will allow the Overlays to be displayed.

import { ReactNavigationOverlay } from "react-navigation-overlay";

<NavigationContainer>
  ...
  <ReactNavigationOverlay />
</NavigationContainer>;

Display an overlay by using the Overlay.show() method, and passing your component and any props.

Overlay.show(MyFirstOverlay, { title: "..." })

...

const MyFirstOverlay = ({ title }) => {
    return ...;
}

Authors

• Luke Brandon Farrell - Author

License

This project is licensed under the MIT License