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+ businesses to send 9 billion Push Notifications per day.

You can find more information on OneSignal here.

Migration Guides

Versions 3.0 were recently released and include breaking changes. See the Migration Guide to update your implementation.

Contents

• Install
• Usage
• API
• Advanced Usage

Install

You can use yarn or npm.

Yarn

yarn add react-onesignal

npm

npm install --save react-onesignal

Usage

Initialize OneSignal with your appId via the options parameter:

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

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

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

Init Options

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

| Property Name | Type | Description | | ---------------------------| --------------------- | -------------------------------------------------- | | appId | string | The ID of your OneSignal app. | | autoRegister | boolean (optional) | Whether or not to automatically register the user. | | autoResubscribe | boolean (optional) | Whether or not to automatically resubscribe the user. | | path | string (optional) | The path to the OneSignal service worker file. | | serviceWorkerPath | string (optional) | The path to the OneSignal service worker script. | | serviceWorkerUpdaterPath | string (optional) | The path to the OneSignal service worker updater script. | | subdomainName | string (optional) | The subdomain of your OneSignal app. | | allowLocalhostAsSecureOrigin | boolean (optional) | Whether or not to allow localhost as a secure origin. | | requiresUserPrivacyConsent| boolean (optional) | Whether or not the user's consent is required. | | persistNotification | boolean (optional) | Whether or not notifications should persist. | | notificationClickHandlerMatch| string (optional) | The URL match pattern for notification clicks. | | notificationClickHandlerAction| string (optional)| The action to perform when a notification is clicked. | | welcomeNotification | object (optional) | The welcome notification configuration. | | notifyButton | object (optional) | The notify button configuration. | | promptOptions | object (optional) | Additional options for the subscription prompt. | | webhooks | object (optional) | The webhook configuration. | | [key: string] | any | Additional properties can be added as needed. |

Service Worker Params You can customize the location and filenames of service worker assets. You are also able to specify the specific scope that your service worker should control. You can read more here.

In this distribution, you can specify the parameters via the following:

| Field | Details | |----------------------------|------------------------------------------------------------------------------------------------------------------------| | serviceWorkerParam | Use to specify the scope, or the path the service worker has control of. Example: { scope: "/js/push/onesignal/" } | | serviceWorkerPath | The path to the service worker file. |

Service Worker File

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.

Typescript

This package includes Typescript support.

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

OneSignal API

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

Advanced Usage

Events and Event Listeners

Use listeners to react to OneSignal-related events:

Notifications Namespace

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

Slidedown Namespace

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

Push Subscription Namespace

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

Example

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

See the OneSignal WebSDK Reference for all available event listeners.

Troubleshooting

window.OneSignal already defined as 'object'!

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!