react-tawk-messenger

Features

• Using React Hooks
• Documented and self-explaining methods
• Small size without any external libraries
• All Javascript API methods are available with 'tawk' prefix (e.g., tawkMaximize, tawkMinimize)
• All callback props also use the 'tawk' prefix (e.g., tawkOnLoad, tawkOnChatStarted)
• Maintained by the tawk.to team, the community and myself (because it seems like no one is updating this).

Installation

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

# Node
npm install react-tawk-messenger

# Yarn
yarn add react-tawk-messenger

Quickstart

Import react-tawk-messenger 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 react-tawk-messenger component.

import TawkMessengerReact from 'react-tawk-messenger';

function App() {
    return (
        <div className="App">
            <TawkMessengerReact
                propertyId="property_id"
                widgetId="default"/>
        </div>
    );
}

Documentation

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

1. How to Use
2. API Reference

Playground

This project includes a playground for testing the component. To run the playground:

npm run playground

See the Playground README for more details.

Other JS frameworks we support

• Vue Js
• Angular Js
• Ember Js

Frequently Asked Questions

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

Here is our guide for the React.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