\n\n\n---\n\nA feature rich Android & iOS notifications library for React Native.\n\n[> Learn More](https://notifee.app/)\n\n## Installation\n\n```bash\nyarn add @notifee/react-native\n```\n\n## Documentation\n\n- [Overview](https://notifee.app/react-native/docs/overview)\n- [Licensing](https://notifee.app/react-native/docs/license-keys)\n- [Reference](https://notifee.app/react-native/reference)\n\n### Android\n\nThe APIs for Android allow for creating rich, styled and highly interactive notifications. Below you'll find guides that cover the supported Android features.\n\n| Topic | |\n| ---------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| [Appearance](https://notifee.app/react-native/docs/android/appearance) | Change the appearance of a notification; icons, colors, visibility etc. |\n| [Behaviour](https://notifee.app/react-native/docs/android/behaviour) | Customize how a notification behaves when it is delivered to a device; sound, vibration, lights etc. |\n| [Channels & Groups](https://notifee.app/react-native/docs/android/channels) | Organize your notifications into channels & groups to allow users to control how notifications are handled on their device |\n| [Foreground Service](https://notifee.app/react-native/docs/android/foreground-service) | Long running background tasks can take advantage of a Android Foreground Services to display an on-going, prominent notification. |\n| [Grouping & Sorting](https://notifee.app/react-native/docs/android/grouping-and-sorting) | Group and sort related notifications in a single notification pane. |\n| [Interaction](https://notifee.app/react-native/docs/android/interaction) | Allow users to interact with your application directly from the notification with actions. |\n| [Progress Indicators](https://notifee.app/react-native/docs/android/progress-indicators) | Show users a progress indicator of an on-going background task, and learn how to keep it updated. |\n| [Styles](https://notifee.app/react-native/docs/android/styles) | Style notifications to show richer content, such as expandable images/text, or message conversations. |\n| [Timers](https://notifee.app/react-native/docs/android/timers) | Display counting timers on your notification, useful for on-going tasks such as a phone call, or event time remaining. |\n\n### iOS\n\nBelow you'll find guides that cover the supported iOS features.\n\n| Topic | |\n| ----------------------------------------------------------------- | ------------------------------------------------------------------------ |\n| [Appearance](https://notifee.app/react-native/docs/ios/appearance) | Change now the notification is displayed to your users. |\n| [Behaviour](https://notifee.app/react-native/docs/ios/behaviour) | Control how notifications behave when they are displayed to a device; sound, crtitial alerts etc. |\n| [Categories](https://notifee.app/react-native/docs/ios/categories) | Create & assign categories to notifications. |\n| [Interaction](https://notifee.app/react-native/docs/ios/interaction) | Handle user interaction with your notifications. | |\n| [Permissions](https://notifee.app/react-native/docs/ios/permissions) | Request permission from your application users to display notifications. | |\n\n### Jest Testing\n\nTo run jest tests after integrating this module, you will need to mock out the native parts of Notifee or you will get an error that looks like:\n\n```bash\n ● Test suite failed to run\n\n Notifee native module not found.\n\n 59 | this._nativeModule = NativeModules[this._moduleConfig.nativeModuleName];\n 60 | if (this._nativeModule == null) {\n > 61 | throw new Error('Notifee native module not found.');\n | ^\n 62 | }\n 63 |\n 64 | return this._nativeModule;\n```\n\nAdd this to a setup file in your project e.g. `jest.setup.js`:\n\nIf you don't already have a Jest setup file configured, please add the following to your Jest configuration file and create the new jest.setup.js file in project root:\n\n```js\nsetupFiles: ['/jest.setup.js'],\n```\n\nYou can then add the following line to that setup file to mock `notifee`:\n\n```js\njest.mock('@notifee/react-native', () => require('@notifee/react-native/jest-mock'))\n```\n\nYou will also need to add `@notifee` to `transformIgnorePatterns` in your config file (`jest.config.js`):\n\n```bash\ntransformIgnorePatterns: [\n 'node_modules/(?!(jest-)?react-native|@react-native|@notifee)'\n]\n```\n\n### Detox Testing\n\nTo utilise Detox's functionality to mock a local notification and trigger notifee's event handlers, you will need a payload with a key `__notifee_notification`:\n\n```js\n{\n title: 'test',\n body: 'Body',\n payload: {\n __notifee_notification: {\n ios: {\n foregroundPresentationOptions: {\n banner: true,\n list: true,\n },\n },\n data: {}\n },\n },\n}\n```\n\nThe important part is to make sure you have a `__notifee_notification` object under `payload` with the default properties.\n\n## License\n\n- See [LICENSE](/LICENSE)\n\n---\n\n
![](\"https://notifee.app/logo-icon.png\"){kind=icon}
![](\"https://static.invertase.io/assets/invertase-logo-small.png\"){kind=logo}
\n