JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 5
  • Score
    100M100P100Q32133F
  • License MIT

A fork of the official onesignal-vue package that works for vue3.

Package Exports

  • onesignal-vue-3
  • onesignal-vue-3/dist/index.es.js
  • onesignal-vue-3/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (onesignal-vue-3) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

onesignal-vue-3

This is a fork of the official onesignal-vue package that has been altered to work with vue3.

Add the following to your main.ts file:

import { createApp } from 'vue';
import OneSignalVue from 'onesignal-vue-3';

createApp(App)
  .use(OneSignalVue, {
    appId: process.env.VUE_APP_ONESIGNAL_APP_ID,
  })
  .mount('#app')

And use the following code in one of your Vue components:

<script lang="ts">
import { onMounted, defineComponent } from 'vue'
import { useOneSignal } from 'onesignal-vue-3'

export default defineComponent({
    setup() {
        const oneSignal = useOneSignal()

        onMounted(async () => {
            await oneSignal.registerForPushNotifications({
                modalPrompt: true,
            })
        })
    }
})
</script>

Please check the docs of the original package to find out more information about possible configurations and usages.