Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tawk/tawk-messenger-vue-2

Official Vue 2 plugin for Tawk messenger
https://github.com/tawk/tawk-messenger-vue-2

nuxt nuxt-plugin nuxt-tawk tawk tawkto vue vue-plugin vue-tawk vue2 vue2-tawk vuejs

Last synced: about 14 hours ago
JSON representation

Official Vue 2 plugin for Tawk messenger

Awesome Lists containing this project

README

        


Tawk Vue logo

## Features
- Compatible on Vue 2 and Nuxt
- Documented and self-explaining methods
- Small size without any external libraries
- All Javascript API methods are avaiable
- Maintained by the [tawk.to](https://www.tawk.to]) team


## Installation
The plugins are available from the node and yarn package managers.
```bash
# Node
npm install @tawk.to/tawk-messenger-vue-2

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


## Quickstart
Import the **tawk-messenger-vue-2** 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**.

```js
import TawkMessengerVue from '@tawk.to/tawk-messenger-vue-2';

Vue.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](docs/ssr-setup.md).


## Documentation

This project includes a `docs` folder with more details on the following:
1. [SPA setup](docs/spa-setup.md)
1. [SSR setup](docs/ssr-setup.md)
1. [API Reference](docs/api-reference.md)


## Other JS frameworks we support
- [Vue 3 JS](https://github.com/tawk/tawk-messenger-vue-3)
- [React Js](https://github.com/tawk/tawk-messenger-react)
- [Angular Js](https://github.com/tawk/tawk-messenger-angular)
- [Ember Js](https://github.com/tawk/tawk-messenger-ember)


## Frequently Asked Questions

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

Here is our guide for the [Vue.js integration](https://help.tawk.to/article/vue-js )

**Where can I find more information and support?**

Visit our [help center](https://help.tawk.to) or reach out in the chat on our [website](https://tawk.to). 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](https://github.com/tawk/tawk-messenger-vue-2/issues)