Basic Usage

Once installed, Notify Kit can be imported into your React Native project:

import notifee from 'react-native-notify-kit';

The default export can then be used to interact with the Notify Kit API, either inside of your React components or standalone (e.g. inside of a Headless Task).

The library also exports the API types, documented within the Reference API. For example to import the AndroidColor type:

import { AndroidColor } from 'react-native-notify-kit';

Projects using TypeScript with React Native can expect Notify Kit to work out of the box with no additional steps required. Simply import the package and the typed API interface will be available.

Using TypeScript in React Native is entirely optional and is not required to use Notify Kit.

Notify Kit supports both Android & iOS using the same interface. The API has been designed to function on both platforms, even in situations whereby functionality may not exist on one platform. In those cases, the API will "noop" or instantly resolve.

To render FCM push notifications with full Notify Kit control on both platforms, use FCM Mode — a layered opt-in on top of the core library:

• A server SDK at react-native-notify-kit/server that builds Firebase Admin-compatible messages for admin.messaging().send() (data-only on Android, alert + mutable-content: 1 on iOS). Firebase Admin serializes them to the FCM HTTP v1 request format.
• A one-liner client handler: notifee.handleFcmMessage(remoteMessage).
• A CLI that scaffolds the iOS Notification Service Extension automatically: npx react-native-notify-kit init-nse.

See the FCM Mode guide for the full architecture, payload schema, and quick-start, or the FCM integration page for a compact summary. FCM Mode is entirely optional — local notifications, trigger notifications, and channels/categories work without it.