Nourishing Pizza Microservice

    vue-gorgias
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.1 • Public • Published

    Vue Gorgias

    npm vue2

    Import & expose functions from Gorgias easily

    Getting started

    To import Gorgias in your VueJS application, you may follow those simple steps:

    Install Vue-Gorgias

    npm install vue-gorgias --save

    Use Vue-Gorgias

    In your main file, import Vue-gorgias:

    import VueGorgias from 'vue-gorgias'
     
    Vue.use(VueGorgias, {
      apiKey: 'YOUR_API_KEY',
      chatId: 'YOUR_CHAT_ID'
    })
     

    The API_KEY and the CHAT_ID are provided by Gorgias.

    Options

    Parameter Description Required Default
    apiKey A unique API identifier provided by Gorgias. true null
    chatId A unique identifier for the chat to use inside the Gorgias system true null
    injectCSS* A path to the CSS to inject inside the Gorgias iframe. This may be a relative or absolute path. false false
    debug Show the debug logs if needed. false false

    *Currently, we do not have a proper way to customize the chat. Because of that, we must inject our own CSS inside the chat iframe. To do so, you can specify a css href to be injected in your options.

    API

    This plugin exposes some methods to help you interact with the Gorgias API. By default, our methods are exposed through Vue.gorgias.

    Ready

    Exposes a function that accepts a callback function. The callback function is called only when the plugin is fully loaded. If called after the plugin has been initialized, the callback will be fired imMediately

    Vue.gorgias.ready(() => {
      // Do your action here
    })

    Update user

    Update the current user informations. We recommend you to make sure the plugin is fully loaded before calling this function like this:

    Vue.gorgias.ready(() => {
      Vue.gorgias.updateUser({
        email: 'user@email.fr',
        givenName: 'some name',
        surname: 'some surname'
      })
    })

    Contribution

    Please make sure to read the Contributing Guide before making a pull request.

    ©️ License

    MIT

    Install

    npm i vue-gorgias

    DownloadsWeekly Downloads

    1

    Version

    1.0.1

    License

    MIT

    Unpacked Size

    30.8 kB

    Total Files

    27

    Last publish

    Collaborators

    • maffpool
    • williamdasilva