@userback/vue2
TypeScript icon, indicating that this package has built-in type declarations

0.3.3 • Public • Published

@userback/vue2

The official NPM module for embedding the Userback.io widget into your Vue2 or Vue3 application. If you are using Vue3 we also have @userback/vue

Installation

npm i @userback/vue2 or yarn add @userback/vue2

Quickstart

To use the Userback plugin you just need to utilize Vue.use and provide your token like so:

import Vue from 'vue';
import UserbackPlugin from '@userback/vue2';

Vue.use(UserbackPlugin, { token: USERBACK_TOKEN });
new Vue({ render: (h) => h(App) }).$mount('#app');

You can access the Userback api via the Vue.prototype.$userback object:

<template>
  <div id="app">
    <button type="button" v-on:click="$userback.open('bug')">Open Bugs</button>
    <button type="button" v-on:click="$userback.open('general', 'screenshot')">Screenshot me!</button>
  </div>
</template>

Nuxt

We also support the Nuxt framework and have an example of it's usage within a project.

// plugins/userback.client.js
import UserbackPlugin from '@userback/vue2';
Vue.use(UserbackPlugin, { token: process.env.USERBACK_TOKEN });

For more information about available configuration settings and and functions available, see our Javascript API

Readme

Keywords

Package Sidebar

Install

npm i @userback/vue2

Weekly Downloads

29

Version

0.3.3

License

MIT

Unpacked Size

5.36 kB

Total Files

7

Last publish

Collaborators

  • aliu_userback
  • lle_userback