@sum.cumo/vue-browserupdate

Vue wrapper for 'browser-update' package

Usage no npm install needed!

<script type="module">
  import sumCumoVueBrowserupdate from 'https://cdn.skypack.dev/@sum.cumo/vue-browserupdate';
</script>

README

Vue-BrowserUpdate

VueJS wrapper for "browser update" package. Used to expose show, click and close events mainly. Forked from: https://github.com/WilliamDASILVA/vue-browserupdate

Table of Contents

Requirements

  • npm
  • VueJS
  • Node

Install

$ npm install --save @sum.cumo/vue-browserupdate

Getting Started

The Vue plugin must be initialized by your vue App. You should import it in your main .js file

import VueBrowserUpdate from '@sum.cumo/vue-browserupdate';

Then you just use the plugin by calling the Vue.use method.

Vue.use(VueBrowserUpdate);

Usage

You still can pass options to browserupdate when calling the Vue.use method.

Vue.use(VueBrowserUpdate, {
    options: {
        // Your browser update options
        container: document.body,
    },
});

You can view the full options here: http://browser-update.org/customize.html

Pass a test key to enable the testing mode.

Vue.use(VueBrowserUpdate, {
    options: {
        // Your browser update options
    },
    test: true,
});

The plugin adds to the Vue object the object 'browserUpdate' that includes 3 functions. The onshow, onclick and onclose requires you to pass a function.

Vue.browserUpdate.onshow(() => {
    // The browser update modal is visible...
});