Installation

Quick start guide for installing and running on React Native.

1. Install via npm

Install Notifee to the root of your React Native project with npm or Yarn

# Using npm
npm install --save @notifee/react-native

# Using Yarn
yarn add @notifee/react-native

2. Autolinking with React Native

Users on React Native 0.60+ automatically have access to "autolinking", requiring no further manual installation steps. To automatically link the package, rebuild your project:

# For iOS
cd ios/ && pod install --repo-update
npx react-native run-ios

# For Android
npx react-native run-android

Miscellaneous

Expo Support

Notifee has a built-in expo plugin you can install into an Expo managed project.

First, add Notifee to your project: expo install @notifee/react-native

Then, add @notifee/react-native to the list of plugins in your app's Expo config (app.json or app.config.js):

{
  "name": "my app",
  "plugins": [
    "@notifee/react-native"
  ]
}

Finally, ensure you run expo prebuild and rebuild your app as described in the "Adding custom native code" guide.

Please note that Notifee needs Java JDK 11+ to build on Android. If you are building the app with EAS, you need to change the image used for the build. You will have to use image as ubuntu-18.04-jdk-11-ndk-r19c or another image that has jdk 11 as in the following configuration. (EAS Build Server Configuration)

eas.json:

{
  "build": {
    "dev": {
      "developmentClient": true,
      "distribution": "internal",
      "android": {
        "image": "ubuntu-18.04-jdk-11-ndk-r19c"
      }
    }
}

Copyright 2020 - 2021 © 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.