Welcome to onesignal-ngx 👋

> This is a JavaScript module that can be used to easily include OneSignal code in a website that uses Angular for its front-end codebase.

- 🏠 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.

> Upgrading from Version 1?
> See our migration guide to get started.

Contents

- Install
- Usage
- API
- Advanced Usage

---

Install

$3

``bash
npm install --save onesignal-ngx
`

$3

`bash
yarn add onesignal-ngx
`

---

Library setup

`js
import { OneSignal } from 'onesignal-ngx';
`

Initialize OneSignal with your appId via the options parameter:

`js
@Component({
selector: 'app-root',
templateUrl: './app.component.html',
styleUrls: ['./app.component.css']
})
export class AppComponent {
title = 'angular-example-app';

constructor(private oneSignal: OneSignal) {
this.oneSignal.init({
appId: "8e7fe838-fbcd-4152-980d-32565a2dcf03",
});
}
}
`

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

Examples

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

`js
this.oneSignal
.init({ appId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' })
.then(() => {
// 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.

---

Example:

`js
this.oneSignal.init({
appId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
serviceWorkerParam: {
scope: '',
},
serviceWorkerPath: '',
});
`

$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 it 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 file is being served successfully.

Troubleshooting:
If you uploaded the file but you cannot access it via your browser search bar, make sure you have told Angular about it via the assets param in your angular.json file.

---

$3

This package includes Typescript support.

`ts
class OneSignal {
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
this.oneSignal.Notifications.addEventListener('click', (event) => {
console.log('The notification was clicked!', event);
});
`

See the OneSignal WebSDK Reference for more info on the available event listeners.

Troubleshooting

$3

#### Check the serviceWorker flag

In your angular.json, see if the serviceWorker flag is set to true. The flag is used to cause the production build to include some extra service worker files that will conflict with the OneSignal worker if they use the same scope. If your web app depends on this flag being true and hence the Angular service worker (ngsw-worker.js`) like in PWA setups, you should customize your OneSignal service worker integration to use a different scope than the Angular service worker. Otherwise, they will conflict. This can be done using the service worker OneSignal initialization params documented above. Click for further details.

---

🤝 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 MIT licensed.

Enjoy!