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: 3 months ago
JSON representation
Official Vue 2 plugin for Tawk messenger
- Host: GitHub
- URL: https://github.com/tawk/tawk-messenger-vue-2
- Owner: tawk
- License: other
- Created: 2021-11-02T12:12:08.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-24T08:28:27.000Z (8 months ago)
- Last Synced: 2025-01-31T05:51:16.704Z (4 months ago)
- Topics: nuxt, nuxt-plugin, nuxt-tawk, tawk, tawkto, vue, vue-plugin, vue-tawk, vue2, vue2-tawk, vuejs
- Language: JavaScript
- Homepage: https://tawk.to
- Size: 928 KB
- Stars: 9
- Watchers: 5
- Forks: 4
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## 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)