Overview
Overview of react-native-notify-kit, the documentation guides and reference API.
react-native-notify-kit is a feature-rich local notification library for React Native (Android + iOS). It is a maintained fork of invertase/notifee, published as react-native-notify-kit on npm. The fork is React Native only (Flutter support has been removed) and targets the New Architecture exclusively (React Native 0.73+).
In addition to the original local-notification API surface, the fork adds a first-class FCM integration (FCM Mode), a zero-dependency server SDK (react-native-notify-kit/server), and a CLI (npx react-native-notify-kit init-nse) that scaffolds the iOS Notification Service Extension automatically.
The library
Notify Kit is a local notifications library and does not integrate with any 3rd party messaging services out of the box — FCM Mode is a layered opt-in on top of that core. This gives you flexibility in how notifications are managed and integrated with new and existing applications.
The library is a successor to the notifications module in React Native Firebase v5. The entire library has been reworked from the ground up focusing on new features, testing, documentation and device compatibility.
Documentation
Our documentation aims to provide a walkthrough guide to integrating react-native-notify-kit with your app on both Android and iOS.
Android vs iOS
A lot of the documentation is broken out into Android concepts vs iOS concepts. The underlying APIs and features provided by Android & iOS are very different. The library aims to provide first-class support for both platforms — see the separate guides for iOS and Android.
Reference API
The reference API provides developers with a deep dive into each method and property the library exposes. The reference is generated from TypeScript and is open source — if you wish to improve any of the types, feel free to submit a Pull Request or file an Issue.