react native push notification
8.1.1
React Native Local and Remote Notifications for iOS and Android
This repository is not actively maintained. The main reason is time. The second one is probably the complexity of notifications on both iOS and Android. Since this project probably need a huge refactor to fix some issue or to implement new features. I think you should probably consider these alternatives: Notifee free since september or react-native-notifications.
If you are interested in being a maintainer of this project, feel free to ask in issues.
Check out for changes and migration in the CHANGELOG:
Changelog
Maintainers are welcome ! Feel free to contact me
Changelog is available from version 3.1.3 here: Changelog
npm install --save react-native-push-notification
yarn add react-native-push-notification
NOTE: If you target iOS you also need to follow the installation instructions for PushNotificationIOS since this package depends on it.
NOTE: For Android, you will still have to manually update the AndroidManifest.xml (as below) in order to use Scheduled Notifications.
Having a problem? Read the troubleshooting guide before raising an issue.
Please read...
The component uses PushNotificationIOS for the iOS part. You should follow their installation instructions.
NOTE: firebase-messaging, prior to version 15 requires to have the same version number in order to work correctly at build time and at run time. To use a specific version:
In your android/build.gradle
ext {
googlePlayServicesVersion = "<Your play services version>" // default: "+"firebaseMessagingVersion = "<Your Firebase version>" // default: "21.1.0"// Other settingscompileSdkVersion = <Your compile SDK version> // default: 23buildToolsVersion = "<Your build tools version>" // default: "23.0.1"targetSdkVersion = <Your target SDK version> // default: 23supportLibVersion = "<Your support lib version>" // default: 23.1.1}NOTE: localNotification() works without changes in the application part, while localNotificationSchedule() only works with these changes:
In your android/app/src/main/AndroidManifest.xml
.....
<uses-permission android:name="android.permission.VIBRATE" />
<uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED"/>
<application ....><!-- Change the value to true to enable pop-up for in foreground on receiving remote notifications (for prevent duplicating while showing local notifications set this to false) --><meta-data android:name="com.dieam.reactnativepushnotification.notification_foreground"android:value="false"/><!-- Change the resource name to your App's accent color - or any other color you want --><meta-data android:name="com.dieam.reactnativepushnotification.notification_color"android:resource="@color/white"/> <!-- or @android:color/{name} to use a standard color --><receiver android:name="com.dieam.reactnativepushnotification.modules.RNPushNotificationActions" />
<receiver android:name="com.dieam.reactnativepushnotification.modules.RNPushNotificationPublisher" />
<receiver android:name="com.dieam.reactnativepushnotification.modules.RNPushNotificationBootEventReceiver">
<intent-filter>
<action android:name="android.intent.action.BOOT_COMPLETED" />
<action android:name="android.intent.action.QUICKBOOT_POWERON" />
<action android:name="com.htc.intent.action.QUICKBOOT_POWERON"/>
</intent-filter>
</receiver>
<serviceandroid:name="com.dieam.reactnativepushnotification.modules.RNPushNotificationListenerService"android:exported="false" >
<intent-filter>
<action android:name="com.google.firebase.MESSAGING_EVENT" />
</intent-filter>
</service>
.....If not using a built in Android color (@android:color/{name}) for the notification_color meta-data item.
In android/app/src/main/res/values/colors.xml (Create the file if it doesn't exist).
<resources> <color name="white">#FFF</color> </resources>
If your app has an @Override on onNewIntent in MainActivity.java ensure that function includes a super call on onNewIntent (if your MainActivity.java does not have an @Override for onNewIntent skip this):
@Overridepublic void onNewIntent(Intent intent) {
...super.onNewIntent(intent);
...
}Make sure you have installed setup Firebase correctly.
In android/build.gradle
buildscript {...
dependencies {...
classpath('com.google.gms:google-services:4.3.3')...
}
}In android/app/build.gradle
dependencies { ...
implementation 'com.google.firebase:firebase-analytics:17.3.0'
...
}
apply plugin: 'com.google.gms.google-services'Then put your google-services.json in android/app/.
Note: firebase/release-notes
The Firebase Android library
firebase-coreis no longer needed. This SDK included the Firebase SDK for Google Analytics.Now, to use Analytics or any Firebase product that recommends the use of Analytics (see table below), you need to explicitly add the Analytics dependency:
com.google.firebase:firebase-analytics:17.3.0.
In android/settings.gradle
...
include ':react-native-push-notification'project(':react-native-push-notification').projectDir = file('../node_modules/react-native-push-notification/android')In your android/app/build.gradle
dependencies {...
implementation project(':react-native-push-notification')...
}Manually register module in MainApplication.java (if you did not use react-native link):
import com.dieam.reactnativepushnotification.ReactNativePushNotificationPackage; // <--- Import Packagepublic class MainApplication extends Application implements ReactApplication { private final ReactNativeHost mReactNativeHost = new ReactNativeHost(this) { @Override protected boolean getUseDeveloperSupport() {return BuildConfig.DEBUG;
} @Override protected List<ReactPackage> getPackages() { return Arrays.<ReactPackage>asList( new MainReactPackage(), new ReactNativePushNotificationPackage() // <---- Add the Package );
}
};
....
}DO NOT USE .configure() INSIDE A COMPONENT, EVEN App
If you do, notification handlers will not fire, because they are not loaded. Instead, use
.configure()in the app's first file, usuallyindex.js.
import PushNotificationIOS from "@react-native-community/push-notification-ios";import PushNotification from "react-native-push-notification";// Must be outside of any component LifeCycle (such as `componentDidMount`).PushNotification.configure({
// (optional) Called when Token is generated (iOS and Android)
onRegister: function (token) {console.log("TOKEN:", token);
},
// (required) Called when a remote is received or opened, or local notification is opened
onNotification: function (notification) {console.log("NOTIFICATION:", notification);// process the notification// (required) Called when a remote is received or opened, or local notification is openednotification.finish(PushNotificationIOS.FetchResult.NoData);
},
// (optional) Called when Registered Action is pressed and invokeApp is false, if true onNotification will be called (Android)
onAction: function (notification) {console.log("ACTION:", notification.action);console.log("NOTIFICATION:", notification);// process the action
},
// (optional) Called when the user fails to register for remote notifications. Typically occurs when APNS is having issues, or the device is a simulator. (iOS)
onRegistrationError: function(err) {console.error(err.message, err);
},
// IOS ONLY (optional): default: all - Permissions to register.
permissions: {alert: true,badge: true,sound: true,
},
// Should the initial notification be popped automatically
// default: true
popInitialNotification: true,
/** * (optional) default: true * - Specified if permissions (ios) and token (android and ios) will requested or not, * - if not, you must call PushNotificationsHandler.requestPermissions() later * - if you are not using remote notification or do not have Firebase installed, use this: * requestPermissions: Platform.OS === 'ios' */
requestPermissions: true,});Example folder contains an example app to demonstrate how to use this package. The notification Handling is done in NotifService.js.
Please test your PRs with this example app before submitting them. It'll help maintaining this repo.
When any notification is opened or received the callback onNotification is called passing an object with the notification data.
Notification object example:
{foreground: false, // BOOLEAN: If the notification was received in foreground or notuserInteraction: false, // BOOLEAN: If the notification was opened by the user from the notification area or notmessage: 'My Notification Message', // STRING: The notification messagedata: {}, // OBJECT: The push data or the defined userInfo in local notifications}PushNotification.localNotification(details: Object)
EXAMPLE:
PushNotification.localNotification({
/* Android Only Properties */
channelId: "your-channel-id", // (required) channelId, if the channel doesn't exist, notification will not trigger.
ticker: "My Notification Ticker", // (optional)
showWhen: true, // (optional) default: true
autoCancel: true, // (optional) default: true
largeIcon: "ic_launcher", // (optional) default: "ic_launcher". Use "" for no large icon.
largeIconUrl: "https://www.example.tld/picture.jpg", // (optional) default: undefined
smallIcon: "ic_notification", // (optional) default: "ic_notification" with fallback for "ic_launcher". Use "" for default small icon.
bigText: "My big text that will be shown when notification is expanded. Styling can be done using HTML tags(see android docs for details)", // (optional) default: "message" prop
subText: "This is a subText", // (optional) default: none
bigPictureUrl: "https://www.example.tld/picture.jpg", // (optional) default: undefined
bigLargeIcon: "ic_launcher", // (optional) default: undefined
bigLargeIconUrl: "https://www.example.tld/bigicon.jpg", // (optional) default: undefined
color: "red", // (optional) default: system default
vibrate: true, // (optional) default: true
vibration: 300, // vibration length in milliseconds, ignored if vibrate=false, default: 1000
tag: "some_tag", // (optional) add tag to message
group: "group", // (optional) add group to message
groupSummary: false, // (optional) set this notification to be the group summary for a group of notifications, default: false
ongoing: false, // (optional) set whether this is an "ongoing" notification
priority: "high", // (optional) set notification priority, default: high
visibility: "private", // (optional) set notification visibility, default: private
ignoreInForeground: false, // (optional) if true, the notification will not be visible when the app is in the foreground (useful for parity with how iOS notifications appear). should be used in combine with `com.dieam.reactnativepushnotification.notification_foreground` setting
shortcutId: "shortcut-id", // (optional) If this notification is duplicative of a Launcher shortcut, sets the id of the shortcut, in case the Launcher wants to hide the shortcut, default undefined
onlyAlertOnce: false, // (optional) alert will open only once with sound and notify, default: false
when: null, // (optional) Add a timestamp (Unix timestamp value in milliseconds) pertaining to the notification (usually the time the event occurred). For apps targeting Build.VERSION_CODES.N and above, this time is not shown anymore by default and must be opted into by using `showWhen`, default: null.
usesChronometer: false, // (optional) Show the `when` field as a stopwatch. Instead of presenting `when` as a timestamp, the notification will show an automatically updating display of the minutes and seconds since when. Useful when showing an elapsed time (like an ongoing phone call), default: false.
timeoutAfter: null, // (optional) Specifies a duration in milliseconds after which this notification should be canceled, if it is not already canceled, default: null
messageId: "google:message_id", // (optional) added as `message_id` to intent extras so opening push notification can find data stored by @react-native-firebase/messaging module.
actions: ["Yes", "No"], // (Android only) See the doc for notification actions to know more
invokeApp: true, // (optional) This enable click on actions to bring back the application to foreground or stay in background, default: true
/* iOS only properties */
category: "", // (optional) default: empty string
subtitle: "My Notification Subtitle", // (optional) smaller title below notification title
/* iOS and Android properties */
id: 0, // (optional) Valid unique 32 bit integer specified as string. default: Autogenerated Unique ID
title: "My Notification Title", // (optional)
message: "My Notification Message", // (required)
picture: "https://www.example.tld/picture.jpg", // (optional) Display an picture with the notification, alias of `bigPictureUrl` for Android. default: undefined
userInfo: {}, // (optional) default: {} (using null throws a JSON value '<null>' error)
playSound: false, // (optional) default: true
soundName: "default", // (optional) Sound to play when the notification is shown. Value of 'default' plays the default sound. It can be set to a custom sound such as 'android.resource://com.xyz/raw/my_sound'. It will look for the 'my_sound' audio file in 'res/raw' directory and play it. default: 'default' (default sound is played)
number: 10, // (optional) Valid 32 bit integer specified as string. default: none (Cannot be zero)
repeatType: "day", // (optional) Repeating interval. Check 'Repeating Notifications' section for more info.});PushNotification.localNotificationSchedule(details: Object)
EXAMPLE:
PushNotification.localNotificationSchedule({
//... You can use all the options from localNotifications
message: "My Notification Message", // (required)
date: new Date(Date.now() + 60 * 1000), // in 60 secs
allowWhileIdle: false, // (optional) set notification to work while on doze, default: false
/* Android Only Properties */
repeatTime: 1, // (optional) Increment of configured repeatType. Check 'Repeating Notifications' section for more info.});PushNotification.popInitialNotification(callback)
EXAMPLE:
PushNotification.popInitialNotification((notification) => {
console.log('Initial Notification', notification);});In android, add your custom sound file to [project_root]/android/app/src/main/res/raw
In iOS, add your custom sound file to the project Resources in xCode.
In the location notification json specify the full file name:
soundName: 'my_sound.mp3'
To use channels, create them at startup and pass the matching channelId through to PushNotification.localNotification or PushNotification.localNotificationSchedule.
import PushNotification, {Importance} from 'react-native-push-notification';... PushNotification.createChannel({ channelId: "channel-id", // (required) channelName: "My channel", // (required) channelDescription: "A channel to categorise your notifications", // (optional) default: undefined. playSound: false, // (optional) default: true soundName: "default", // (optional) See `soundName` parameter of `localNotification` function importance: Importance.HIGH, // (optional) default: Importance.HIGH. Int value of the Android notification importance vibrate: true, // (optional) default: true. Creates the default vibration pattern if true.},(created) => console.log(`createChannel returned '${created}'`) // (optional) callback returns whether the channel was created, false means it already existed.
);NOTE: Without channel, notifications don't work
In the notifications options, you must provide a channel id with channelId: "your-channel-id", if the channel doesn't exist the notification might not be triggered. Once the channel is created, the channel cannot be updated. Make sure your channelId is different if you change these options. If you have created a channel in another way, it will apply options of the channel.
If you want to use a different default channel for remote notification, refer to the documentation of Firebase:
Set up a Firebase Cloud Messaging client app on Android
<meta-data android:name="com.google.firebase.messaging.default_notification_channel_id" android:value="@string/default_notification_channel_id" />
For local notifications, the same kind of option is available:
you can use:
<meta-data android:name="com.dieam.reactnativepushnotification.default_notification_channel_id" android:value="@string/default_notification_channel_id" />
If not defined, fallback to the Firebase value defined in the AndroidManifest:
<meta-data android:name="com.google.firebase.messaging.default_notification_channel_id" android:value="..." />
If not defined, fallback to the default Firebase channel id fcm_fallback_notification_channel
You can list available channels with:
PushNotification.getChannels(function (channel_ids) {
console.log(channel_ids); // ['channel_id_1']});You can check if a channel exists with:
PushNotification.channelExists(channel_id, function (exists) {
console.log(exists); // true/false});You can check if a channel blocked with:
PushNotification.channelBlocked(channel_id, function (blocked) {
console.log(blocked); // true/false});You can delete a channel with:
PushNotification.deleteChannel(channel_id);
The id parameter for PushNotification.localNotification is required for this operation. The id supplied will then be used for the cancel operation.
PushNotification.localNotification({...id: '123'...});PushNotification.cancelLocalNotification('123' 
