README.md 2.13 KB
Newer Older
yogevbd's avatar
yogevbd committed
1 2 3 4
# React Native Notifications
![npm](https://img.shields.io/npm/dw/react-native-notifications.svg)
[![Build Status](https://img.shields.io/jenkins/s/http/jenkins-oss.wixpress.com:8080/job/multi-react-native-notifications-master.svg)](https://jenkins-oss.wixpress.com/job/multi-react-native-notifications-master/)
[![npm (tag)](https://img.shields.io/npm/v/react-native-notifications/snapshot.svg)](https://github.com/wix/react-native-navigation/tree/master)
Lidan's avatar
Lidan committed
5

Lidan Hifi's avatar
Lidan Hifi committed
6
Handle all the aspects of push notifications for your app, including remote and local notifications, interactive notifications, silent notifications, and more.
Lidan Hifi's avatar
Lidan Hifi committed
7

Amit Davidi's avatar
Amit Davidi committed
8
**All the native iOS notifications features are supported!** 
Lidan's avatar
Lidan committed
9

10
_For information regarding proper integration with [react-native-navigation](https://github.com/wix/react-native-navigation), follow [this wiki](https://github.com/wix/react-native-notifications/wiki/Android:-working-with-RNN)._
Amit Davidi's avatar
Amit Davidi committed
11

12

d4vidi's avatar
d4vidi committed
13
### iOS
Lidan Hifi's avatar
Lidan Hifi committed
14

d4vidi's avatar
d4vidi committed
15
<img src="https://s3.amazonaws.com/nrjio/interactive.gif" alt="Interactive notifications example" width=350/>
Lidan Hifi's avatar
Lidan Hifi committed
16

d4vidi's avatar
d4vidi committed
17 18 19 20 21
- Remote (push) notifications
- Local notifications
- Background/Managed notifications (notifications that can be cleared from the server, like Facebook messenger and Whatsapp web)
- PushKit API (for VoIP and other background messages)
- Interactive notifications (allows you to provide additional functionality to your users outside of your application such as action buttons)
Lidan Hifi's avatar
Lidan Hifi committed
22

d4vidi's avatar
d4vidi committed
23
### Android
Amit Davidi's avatar
Amit Davidi committed
24

25 26
- Receiving notifications in any App state (foreground, background, "dead")
- Built-in notification drawer management
27
- High degree of code extensibility to allow for advanced custom layouts and any specific notifications behavior as available by [Android's API](https://developer.android.com/training/notify-user/build-notification.html)
28 29
- Android equivalent of React-Native's implementation of [`PushNotificationsIOS.getInitialNotification()`](https://facebook.github.io/react-native/docs/pushnotificationios.html#getinitialnotification).

30
_Upcoming: local notifications, background-state Rx queue (iOS equivalent)_
Lidan Hifi's avatar
Lidan Hifi committed
31 32


yogevbd's avatar
yogevbd committed
33 34
# Quick Links
- [Documentation](https://wix.github.io/react-native-notifications/)
35

36
# License
Lidan Hifi's avatar
Lidan Hifi committed
37 38
The MIT License.

Marc Sommerhalder's avatar
Marc Sommerhalder committed
39
See [LICENSE](LICENSE)