Welcome to onesignal-vue3 👋

> This is a JavaScript module that can be used to easily include OneSignal code in a website or app that uses Vue 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 with v2.

Contents

- Install
- Usage
- API
- Advanced Usage

---

Vue Compatibility

Make sure you install a plugin version compatible with your Vue environment.

| Vue | OneSignal Plugin |
| --- | ----------------------------------------------------------- |
| 2 | onesignal-vue |
| 3 | onesignal-vue3 |

Install

Run npm install

$3

``bash
yarn add @onesignal/onesignal-vue3
`

$3

`bash
npm install --save @onesignal/onesignal-vue3
`

$3

`bash
yarn add @onesignal/onesignal-vue3
`

---

Usage

Plugin setup

In Vue 3, you can pass in the OneSignal initialization options directly as an argument to the use function. You can still initialize separately if you prefer editor benefits like code-completion.

`js
// main
import { createApp } from 'vue';
import OneSignalVuePlugin from '@onesignal/onesignal-vue3';

createApp(App)
.use(OneSignalVuePlugin, {
appId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
})
.mount('#app');
`

or

`js
//main
import { createApp } from 'vue';
import OneSignalVuePlugin from '@onesignal/onesignal-vue3';

createApp(App).use(OneSignalVuePlugin).mount('#app');

// component
this.$OneSignal.init({
appId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
});
`

The OneSignal plugin automatically exposes a $OneSignal global property accessible inside the application.

$3

You can also leverage Vue's Composition API via the useOneSignal function that can be called from within setup.

Reference

$3

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.

---

$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

If IntelliSense is not working as expected in your .vue file, try adding an import from the OneSignal plugin.

!intellisense

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

See the OneSignal WebSDK Reference for all available event listeners.

---

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

Enjoy!