Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

tawk-messenger-vue-3-ts

zingfeng566Apache-2.01.0.1TypeScript support: included

Unofficial Vue 3 plugin for Tawk messenger (support Typescript)

vuejs, vue, vue3, nuxt, vue-plugin, tawk, nuxt-plugin, typescript, tawkto, vue-tawk, vue3-tawk, nuxt-tawk

readme

Tawk Vue logo

Additional feature

  • Support Typescript

Features

  • Compatible on Vue 3 and Nuxt
  • Documented and self-explaining methods
  • Small size without any external libraries
  • All Javascript API methods are avaiable
  • Maintained by the tawk.to team

Installation

The plugins are available from the node and yarn package managers.

# Node
npm install @tawk.to/tawk-messenger-vue-3

# Yarn
yarn add @tawk.to/tawk-messenger-vue-3

Quickstart

Import the tawk-messenger-vue in your main JavaScript file in src/ folder. The propertyId and widgetId will be found on your tawk Dashboard.

Log in to your account and go to Administration > Channels > Chat Widget.

import TawkMessengerVue from '@tawk.to/tawk-messenger-vue-3';

app.use(TawkMessengerVue, {
    propertyId : 'property_id',
    widgetId : 'widget_id'
});

Server Side Rendering

If you will use the plugin with Nuxt JS follow this guide for setup.


Documentation

This project includes a docs folder with more details on the following:

  1. SPA setup
  2. SSR setup
  3. API Reference

Other JS frameworks we support


Frequently Asked Questions

Do you have a knowledge base or article to support implementation?

Here is our guide for the Vue.js integration

Where can I find more information and support?

Visit our help center or reach out in the chat on our website. Our agents are available to assist you 24/7.

Where can I submit a suggestion or report a bug?

Check to see if the issue already exists. If not, open a new issue in the Issues tab