Skip to content

Latest commit

 

History

History
103 lines (79 loc) · 3.63 KB

installation.md

File metadata and controls

103 lines (79 loc) · 3.63 KB
Raw
title description next previous
Installation
Quick start guide for installing and running on React Native.
/react-native/docs/release-notes
/react-native/docs/environment-support

1. Install from npmjs.com

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. Configuration Changes

2a. Android API versions

The values of the compileSdkVersion & targetSdkVersion might need to be changed. compileSdkVersion needs to be at least 33. In addition, if your app is going to request permission on Android 13 via requestPermission, targetSdkVersion needs to be at least 33, as well. These setting are in the file /android/build.gradle.

buildscript {
  ext {
    compileSdkVersion = 33 // at least 33
    targetSdkVersion = 33 // If requesting permission on Android 13 via requestPermission, at least 33 
    ... 
 } 
 ... 
}

Your android project will fail to build with missing symbols if you do not alter these settings, as we require API33 symbols to support Android 13 notification permissions.

2b. Gradle versions

The minimum version of gradle is 7.2.x, and the mimimum version of the android gradle plugin is 7.1.x.

Your android project will fail to build with errors related to resource compilation / packaging if you do not use a new enough android gradle plugin / gradle combination.

3. 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

To be able to run Notifee, it is necessary to compile your Android app with compileSdkVersion of 33. As of Expo SDK 48, this is a default, so unless you're overriding the compileSdkVersion, there's no additional actions you need to take.

If, however, you're currently compiling your app for SDK version lower than 33, please utilize the expo-build-properties config plugin to bump the compileSdkVersion to 33. First, install expo-build-properties:

npx expo install expo-build-properties

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": [
    [
        "expo-build-properties",
        {
          "android": {
            "compileSdkVersion": 33,
            "targetSdkVersion": 33 // Only needed if requesting permission on Android 13 via requestPermission, at least 33 
          },
        },
      ],
  ]
}

Finally, ensure you run npx 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"
      }
    }
}