Skip to main content

notification-kit Docs

One API for push, local, and in-app notifications across Web, iOS, and Android — for React + Capacitor apps.

Push notifications

One token-management API on top of Firebase Cloud Messaging or OneSignal. Request permission, get the device token, subscribe to topics, and receive messages — the same calls on Web, iOS, and Android.

Local notifications

Schedule one-off or recurring notifications through @capacitor/local-notifications: fire at a date, after a delay, or on a calendar pattern. Cancel, list pending, and read delivered notifications.

In-app notifications

Toast-style success / error / warning / info notifications rendered in your app with positions, durations, actions, and dismiss callbacks. Works in any browser — no native plugin needed.

Android channels

Create, list, and delete notification channels with importance, visibility, sound, vibration, and lights. Channel calls are no-ops on non-Android platforms, so you can call them unconditionally.

Zero required dependencies

Every peer dependency is optional. The core works with nothing installed; Firebase, OneSignal, React, and the Capacitor plugins are loaded dynamically only when you actually use them.

TypeScript + React hooks

Full type definitions ship with the package, plus a notification-kit/react entry point exposing useNotifications and in-app hooks. Dual ESM + CJS build for any bundler.

Built and maintained by Ahsan Mahmood LinkedIn · GitHub · npm