vue-intercom
A reactive wrapper for Intercom's JavaScript API
Installation
npm install --save vue-intercom
;; Vue;
Usage
vue-intercom
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.
el: '#app' { return userId: 1 name: 'Foo Bar' email: 'foo@bar.com' ; } { this$intercom; this$intercom; } watch: { this$intercom; } ;
Example App
cd example
yarn
yarn dev
API
Values
$intercom.ready
Set to true
once the Intercom script has been loaded.
$intercom.visible
Set via the onShow
/onHide
events.
$intercom.unreadCount
Set via the onUnreadCountChange
event.
Methods
$intercom.boot(/* optional */options)
Calls Intercom('boot')
. Automatically sets the app_id
unless specified in the options object.
$intercom.shutdown()
Calls Intercom('shutdown')
.
$intercom.update(/* optional */options)
Calls Intercom('update')
. If the options object is set, calls Intercom('update', options)
$intercom.show()
Calls Intercom('show')
.
$intercom.hide()
Calls Intercom('hide')
.
$intercom.showMessages()
Calls Intercom('showMessages')
.
$intercom.showNewMessage(/* optional */content)
Calls Intercom('showNewMessage')
with pre-populated content if provided.
$intercom.trackEvent(name, /* optional */metadata)
Calls Intercom('trackEvent')
with extra metadata if provided.
$intercom.getVisitorId()
Calls Intercom('getVisitorId')
.
License
Copyright (c) 2017 Continuon