Welcome to react-onesignal 👋

> This is a JavaScript module that can be used to easily include OneSignal code in a website or app in practically any JS front-end codebase (not limited to React).

- 🏠 Homepage
- 🖤 npm

OneSignal is the world's leader for Mobile Push Notifications, Web Push, and In-App Messaging. It is trusted by 2 million+ developers to send 12 billion Push Notifications per day.

You can find more information on OneSignal here.

$3

Version 3.0 was recently released and includes breaking changes. See the Migration Guide to update your implementation.

Contents

- Install
- Usage
- API
- Advanced Usage

---

Install

$3

``bash
npm install --save react-onesignal
`

$3

`bash
yarn add react-onesignal
`

---

Usage

Initialize OneSignal with your appId via the options parameter:

`js
import OneSignal from 'react-onesignal';

OneSignal.init({ appId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' });
`

The init function returns a promise that resolves when OneSignal is loaded.

Examples

`js
await OneSignal.init({ appId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' });
// do other stuff
`

---

`js
const [initialized, setInitialized] = useState(false);
OneSignal.init({ appId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' }).then(() => {
setInitialized(true);
OneSignal.Slidedown.promptPush();
// do other stuff
});
`

$3

You can pass other options to the init function. Use these options to configure personalized prompt options, auto-resubscribe, and more.

---

$3

If you haven't done so already, you will need to add the OneSignal Service Worker file to your site (learn more).

The OneSignal SDK file must be publicly accessible. You can put them in your top-level root or a subdirectory. However, if you are placing the file not on top-level root make sure to specify the path via the service worker params in the init options (see section above).

Tip:
Visit https://yoursite.com/OneSignalSDKWorker.js in the address bar to make sure the files are being served successfully.

---

$3

This package includes Typescript support.

`ts
interface IOneSignalOneSignal {
Slidedown: IOneSignalSlidedown;
Notifications: IOneSignalNotifications;
Session: IOneSignalSession;
User: IOneSignalUser;
Debug: IOneSignalDebug;
login(externalId: string, jwtToken?: string): Promise;
logout(): Promise;
init(options: IInitObject): Promise;
setConsentGiven(consent: boolean): Promise;
setConsentRequired(requiresConsent: boolean): Promise;
}
`

$3

See the official OneSignal WebSDK reference for information on all available SDK functions.

---

Advanced Usage

$3

Use listeners to react to OneSignal-related events:

$3

| Event Name | Callback Argument Type |
| ------------------------- | -------------------------------------- |
| 'click' | NotificationClickEvent |
| 'foregroundWillDisplay' | NotificationForegroundWillDisplayEvent |
| 'dismiss' | NotificationDismissEvent |
| 'permissionChange' | boolean |
| 'permissionPromptDisplay' | void |

$3

| Event Name | Callback Argument Type |
| ---------------- | ---------------------- |
| 'slidedownShown' | boolean |

$3

| Event Name | Callback Argument Type |
| ---------- | ---------------------- |
| 'change' | boolean |

Example

`js
OneSignal.Notifications.addEventListener('click', (event) => {
console.log('The notification was clicked!', event);
});
`

See the OneSignal WebSDK Reference for all available event listeners.

Troubleshooting

$3

You will get this error if you initialize twice. Make sure you are only initializing one time. When wrapped with React.StrictMode, your app might be rendering twice.

Example App

This repo includes an example React application implementing OneSignal. It was created using create-react-app. The app uses this repository's root level directory as the react-onesignal` package and will bundle any changes on every run.

---

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

OneSignal

- Website
- Twitter: @onesignal
- Github: @OneSignal
- LinkedIn: @onesignal

Discord

Reach out to us via our Discord server!

📝 License

Copyright © 2023 OneSignal.

This project is Modified MIT licensed.

Thanks

Special thanks to pedro-lb and others for work on the project this package is based on.

Enjoy!