Manageable local notifications for React Native on iOS and Android. Create, update and delete local notifications by their unique id. The push notification title is the app name. When you open the app all displayed local notifications will be removed and the badge counter will be reset on iOS.
NOTICE:
NOTIFICATIONS WILL NOT BE SHOWN WHEN YOUR APP IS IN THE FOREGROUND. (options to handle this situation might be added in future releases)
For latest Android versions, please check notification settings and battery management settings if notifications are not shown at the specified time. This libary aims to deliver exact notifications, which are not delayed by the system. Creating a never ending back- or foregroundservice (API lvl >=26) can help stopping the device to kill your apps and not show your notifications on exact times. Also see https://dontkillmyapp.com for more info and tips to solve this problem for devices with custom battery saving packages.
Fast and easy:
npm install react-native-local-notifications --save
react-native link react-native-local-notifications
Keep in mind that the link step only links the project in the native projects, more steps have to be done for both platforms, which are described in the Android and iOS section below... please verify manually that the link command successfully linked the libray to your project!
Or manual: add the latest version as dependeny to your package.json.
{
"name": "YourProject",
...
},
"dependencies": {
...
"react-native-local-notifications": "2.0.0",
...
}
- (void)applicationDidBecomeActive:(UIApplication *)application
{
[[UIApplication sharedApplication] setApplicationIconBadgeNumber:0]; //Allways reset number of notifications shown at the icon
for (UILocalNotification * notification in [[UIApplication sharedApplication] scheduledLocalNotifications]) { //Also remove all shown notifications
if ([notification.fireDate compare:[NSDate date]] == NSOrderedAscending) {
[[UIApplication sharedApplication] cancelLocalNotification:notification];
}
}
}
if ([UIApplication instancesRespondToSelector:@selector(registerUserNotificationSettings:)]) {
[[UIApplication sharedApplication] registerUserNotificationSettings:[UIUserNotificationSettings settingsForTypes:UIUserNotificationTypeAlert|UIUserNotificationTypeSound categories:nil]];
}
<receiver android:process=":remote" android:name="com.github.wumke.RNLocalNotifications.AlarmReceiver" android:exported="true"></receiver>
import android.content.Context;
import android.app.NotificationManager;
...
@Override
public void onResume() {
super.onResume();
NotificationManager nMgr = (NotificationManager) getSystemService(Context.NOTIFICATION_SERVICE);
nMgr.cancelAll();
}
include ':react-native-local-notifications', ':app'
project(':react-native-local-notifications').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-local-notifications/android')
compile project(':react-native-local-notifications')
import com.github.wumke.RNLocalNotifications.RNLocalNotificationsPackage;
...
@Override
protected List<ReactPackage> getPackages() {
return Arrays.<ReactPackage>asList(
...
new RNLocalNotificationsPackage(),
...
);
}
...
import RNLocalNotifications from 'react-native-local-notifications';
...
//RNLocalNotifications.setAndroidIcons(largeIconName, largeIconType, smallIconName, smallIconType);
RNLocalNotifications.setAndroidIcons("ic_launcher", "mipmap", "notification_small", "drawable"); //this are the default values, this function is optional
//RNLocalNotifications.createNotification(id, text, datetime, sound[, hiddendata]);
RNLocalNotifications.createNotification(1, 'Some text', '2017-01-02 12:30', 'default');
//RNLocalNotifications.updateNotification(id, text, datetime, sound[, hiddendata]);
RNLocalNotifications.updateNotification(1, 'Some modifications to text', '2017-01-02 12:35', 'silence');
//RNLocalNotifications.deleteNotification(id);
RNLocalNotifications.deleteNotification(1);
...
Convert your ringtone to .caf and .mp3 file formats.
iOS: Add yoursound.caf to the Resources folder of your xcode project.
Android: Add yoursound.mp3 to the 'raw' folder
Use 'yoursound' as string for the sound parameter.
When you need to include custom, non-visible, data (for example object id's) to your notifications provide the optional 'hiddendata' parameter to createNotification/updateNotification.
The value will be available as hiddendata (Android) or userData.hiddendata (iOS) when you click the notification.
Note that 'hiddendata' must be a string, so if you want to include json objects you need to encode/decode the data yourself.
This project uses semantic versioning: MAJOR.MINOR.PATCH. This means that releases within the same MAJOR version are always backwards compatible. For more info see semver.org.
MIT (see LICENCE file)
See https://www.npmjs.com/package/react-native-local-notifications?activeTab=versions
Breaking changes
New features / Updates
Fixes
Todo