@leadent/intercom-vue-plugin NPM

intercom.com Vue.js Plugin

A reactive wrapper for Intercom's JavaScript API

Installation

npm install intercom-vue-plugin

In src/main.js

import Vue from 'vue';
import IntercomVuePlugin from '@leadent/intercom-vue-plugin';

Vue.use(IntercomVuePlugin, { app_id: 'your-app-id' });

Note: Option parameters can be set when initalising the plugin (as above) or when booting the plugin (as below) which will override any initial options settings.

Usage

intercom-vue-plugin handles the injection of Intercom's script into your html and wraps calls to the Intercom API with methods and exposes them through the $intercom object in your components.

new Vue({
  el: '#app',
  data() {
    return {
      userId: 1,
      name: 'Foo Bar',
      email: 'foo@bar.com',
    };
  },
  mounted() {
    this.$intercom.boot({
      user_id: this.userId,
      name: this.name,
      email: this.email,
    });
    this.$intercom.show();
  },
  watch: {
    email(email) {
      this.$intercom.update({ email });
    },
  }
});

Example App

npm run build
cd example/
npm run serve

API

Values

`$intercom.ready`

Set to true once the Intercom script has been loaded. There is no need to wait for this property, the plugin watches this internally and will only pass user calls to methods and properties to Intercom once this is true.