Nuxt-chatra-module NPM

💬 nuxt-chatra-module

Simple Nuxt.js Chatra integration.

Installation

yarn add nuxt-chatra-module # npm i nuxt-chatra-module

Add chatra section with options to your nuxt.config.js,

check all options below, only id option is required.

Also you must add nuxt-chatra-module to modules section:

export default {
  chatra: {
    id: 'abcdefghijklmnopq'
  },
  modules: [
    'nuxt-chatra-module'
  ]
}

Options

To customize your chatra, you must use setup option:

// nuxt.config.js
export default {
  chatra: {
    id: 'abcdefghijklmnopq',
    setup: {
      // ...
    }
  }
}

To check, what setup options is available go to api reference.

Methods

You can call chatra methods directly from Vue instances, components/OpenChatBtn.vue:

<template>
  <button @click='openChat'>Open chat</button>
</template>

<script>
export default {
  methods: {
    openChat () {
      this.$chatra.openChat()
    }
  }
}
</script>

All methods are in this.$chatra space, to check all supported methods, go to methods api reference.

TODO

Support all methods from api
Unit testing
Yarn PnP
Full documentation

Development

This package use yarn workspaces. It's just to separate nuxt testing dev space and our module.

You can make changes by:

# git clone
cd nuxt-chatra-module
yarn
# provide chatra id and start nuxt dev server
CHATRA_ID=abcdefghijklmnopq yarn dev
# change something in packages/nuxt-chatra-module
git commit .