https://github.com/qeepsake/react-navigation-overlay
Don't we all wish that React Navigation had awesome Overlays like React Native Navigation ? Now it does 💪
https://github.com/qeepsake/react-navigation-overlay
Last synced: 10 months ago
JSON representation
Don't we all wish that React Navigation had awesome Overlays like React Native Navigation ? Now it does 💪
- Host: GitHub
- URL: https://github.com/qeepsake/react-navigation-overlay
- Owner: Qeepsake
- Created: 2020-12-16T14:18:06.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-10-19T13:43:21.000Z (almost 3 years ago)
- Last Synced: 2025-04-09T23:38:38.676Z (over 1 year ago)
- Language: TypeScript
- Size: 998 KB
- Stars: 2
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# React Navigation Overlay
This library attempts to add support for "Overlays" to React Navigation similar to the `showOverlay` API in React Native Navigation.
## Install
```sh
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.
```js
import { ReactNavigationOverlay } from "react-navigation-overlay";
...
;
```
Display an overlay by using the `Overlay.show()` method, and passing your component and any props.
```js
Overlay.show(MyFirstOverlay, { title: "..." })
...
const MyFirstOverlay = ({ title }) => {
return ...;
}
```
## Authors
- [**Luke Brandon Farrell**](https://lukebrandonfarrell.com/) - _Author_
## License
This project is licensed under the MIT License