The documentation is currently a work in progress whilst the product is in alpha.

Overview

Overview of Notifee, the documentation guides and reference API.

Notifee is a library for React Native, bringing local notification support to both Android & iOS applications.

Whilst free for development, to use Notifee in production (release builds) you must first purchase a license. To learn more about licenses and why they are required, see the Frequently Asked Questions. We offer free licenses to React Native Firebase core contributors, free Open Source applications & non-profit organisations. If you wish to request a free license, please contact us.

The library

Notifee is a local notifications library and does not integrate with any 3rd party messaging services. This provides developers greater flexibility on 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.

Alternative solutions

With Notifee requiring a paid license for release builds, we appreciate this model may not be viable for everyone. Other Open Source alternatives are available if required:

Paid licenses allow us to ensure the library is well maintained & ensures on-going support to the user base. To learn more see our Frequently Asked Questions.

Documentation

Our documentation aims to provide a walkthrough guide to integrating notifee with your app on both Android & iOS platforms.

Android vs iOS

A lot of the Notifee documentation is broken out into Android Concepts vs iOS Concepts. The underlying APIs & features provided by Android & iOS are very different. Notifee aims to provide first-class support for both platforms which is why there are separate guides for iOS & Android.

Reference API

The Notifee reference API provides developers with a deep dive into each of the methods & properties which the API exposes. The reference is generated from TypeScript & is Open Source - if you wish to improve any of the types, feel free to submit a Pull Request or file an Issue.


Copyright 2020 © Invertase Limited

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License and code samples are licensed under the Apache 2.0 License.

All product names, logos, and brands are property of their respective owners. All company, product and service names used in this website are for identification purposes only. Use of these names, logos, and brands does not imply endorsement.