README.md 2.72 KB
Newer Older
Lidan's avatar
Lidan committed
1 2
# React Native Notifications [![Build Status](https://travis-ci.org/wix/react-native-notifications.svg)](https://travis-ci.org/wix/react-native-notifications)

Lidan Hifi's avatar
Lidan Hifi committed
3
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
4

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

7
_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
8

9 10

## iOS
Lidan Hifi's avatar
Lidan Hifi committed
11

Lidan Hifi's avatar
Lidan Hifi committed
12 13 14 15
- [Remote notifications](#handling-received-notifications).
- [Local notifications](#triggering-local-notifications).
- [Background notifications](#managed-notifications-ios-only).
- [Managed notifications](#managed-notifications-ios-only) (notifications that can be cleared from the server, like Facebook messenger and Whatsapp web).
Lidan Hifi's avatar
Lidan Hifi committed
16
- [PushKit API](#pushkit-api-ios-only) for VoIP and other background messages.
Lidan Hifi's avatar
Lidan Hifi committed
17
- [Interactive notifications](#interactive--actionable-notifications-ios-only) that allows you to provide additional functionality to your users outside of your application.
Lidan Hifi's avatar
Lidan Hifi committed
18

19
<img src="https://s3.amazonaws.com/nrjio/interactive.gif" alt="Interactive notifications example" width=300/>
Lidan Hifi's avatar
Lidan Hifi committed
20

21
## Android
Amit Davidi's avatar
Amit Davidi committed
22

23 24
- Receiving notifications in any App state (foreground, background, "dead")
- Built-in notification drawer management
25
- 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)
26 27
- Android equivalent of React-Native's implementation of [`PushNotificationsIOS.getInitialNotification()`](https://facebook.github.io/react-native/docs/pushnotificationios.html#getinitialnotification).

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


31
# Table of Content
Lidan Hifi's avatar
Lidan Hifi committed
32

33 34 35 36 37 38
- [Installation and setup](./docs/installation.md) - Setting up the library in your app
- [Subscription](./docs/subscription.md) - Signing in to push notifications vendors (e.g. GCM)
- [Notification Events (notfications core)](./docs/notificationsEvents.md) - Handling push notification arrival, notification opening by users
- [Local notifications](./docs/localNotifications.md) - Manually triggering notifications (i.e. not via push)
- [Advanced iOS topics](./docs/advancedIos.md) - e.g. managed notifications, PushKit API, Notifications actions
- [Notifications layout control - Android (wiki page)](https://github.com/wix/react-native-notifications/wiki/Android:-Layout-Customization) - Learn how to fully customize your notifications layout on Android!
39

40
# License
Lidan Hifi's avatar
Lidan Hifi committed
41 42
The MIT License.

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