https://github.com/tawk/tawk-messenger-react

Official React plugin for Tawk messenger
https://github.com/tawk/tawk-messenger-react

next next-plugin next-tawk react react-plugin react-tawk reactjs tawk tawkto

Last synced: about 7 hours ago
JSON representation

Official React plugin for Tawk messenger

• Host: GitHub
• URL: https://github.com/tawk/tawk-messenger-react
• Owner: tawk
• License: other
• Created: 2021-11-24T08:00:39.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-25T00:44:25.000Z (about 2 months ago)
• Last Synced: 2024-10-28T17:25:03.129Z (18 days ago)
• Topics: next, next-plugin, next-tawk, react, react-plugin, react-tawk, reactjs, tawk, tawkto
• Language: JavaScript
• Homepage: https://www.tawk.to
• Size: 728 KB
• Stars: 23
• Watchers: 4
• Forks: 15
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


    






## Features

* Using React Hooks

* Documented and self-explaining methods

* Small size without any external libraries

* All Javascript API methods are available

* 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-react

# Yarn

yarn add @tawk.to/tawk-messenger-react

```




## Quickstart

Import **tawk-messenger-react** into the App.js file of your **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**.

When using the API, you will need to use the **useRef** to access the object functions from the **tawk-messenger-react** component.

```js

import TawkMessengerReact from '@tawk.to/tawk-messenger-react';

function App() {

    return (

        


            

        

    );

}

```





## Documentation

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

1.  [How to Use](docs/how-to-use.md)

1.  [API Reference](docs/api-reference.md)




## Other JS frameworks we support

- [Vue Js](https://github.com/tawk/tawk-messenger-vue)

- [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 [React.js integration](https://help.tawk.to/article/react-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/issues)