@du201/react-chat-widget v3.1.6

React Chat Widget

du201's Forked Version

This version adds the emoji functionality to the chat Besides, css-loader is added to webpack due to the use of bootstrap

Sponsors

Features

• Plain text message UI
• Snippet style for links (only as responses for now)
• Fully customizable
• Easy to use

Installation

npm

npm install --save react-chat-widget

yarn

yarn add react-chat-widget

Usage

1- Add the Widget component to your root component

import React from 'react';
import { Widget } from 'react-chat-widget';

import 'react-chat-widget/lib/styles.css';

function App() {
  return (
    <div className="App">
      <Widget />
    </div>
  );
}

export default App;

2- The only required prop you need to use is the handleNewUserMessage, which will receive the input from the user.

import React from 'react';
import { Widget } from 'react-chat-widget';

import 'react-chat-widget/lib/styles.css';

function App() {
  const handleNewUserMessage = (newMessage) => {
    console.log(`New message incoming! ${newMessage}`);
    // Now send the message throught the backend API
  };

  return (
    <div className="App">
      <Widget
        handleNewUserMessage={handleNewUserMessage}
      />
    </div>
  );
}

export default App;

3- Import the methods for you to add messages in the Widget. (See messages)

import React from 'react';
import { Widget, addResponseMessage } from 'react-chat-widget';

import 'react-chat-widget/lib/styles.css';

function App() {
  useEffect(() => {
    addResponseMessage('Welcome to this awesome chat!');
  }, []);

  const handleNewUserMessage = (newMessage) => {
    console.log(`New message incoming! ${newMessage}`);
    // Now send the message throught the backend API
    addResponseMessage(response);
  };

  return (
    <div className="App">
      <Widget
        handleNewUserMessage={handleNewUserMessage}
      />
    </div>
  );
}

export default App;

4- Customize the widget to match your app design! You can add both props to manage the title of the widget and the avatar it will use. Of course, feel free to change the styles the widget will have in the CSS

import React, { useEffect } from 'react';
import { Widget, addResponseMessage } from 'react-chat-widget';

import 'react-chat-widget/lib/styles.css';

import logo from './logo.svg';

function App() {
  useEffect(() => {
    addResponseMessage('Welcome to this awesome chat!');
  }, []);

  const handleNewUserMessage = (newMessage) => {
    console.log(`New message incoming! ${newMessage}`);
    // Now send the message throught the backend API
  };

    return (
      <div className="App">
        <Widget
          handleNewUserMessage={handleNewUserMessage}
          profileAvatar={logo}
          title="My new awesome title"
          subtitle="And my cool subtitle"
        />
      </div>
    );
}

export default App;

API

Props

(required props below:) |prop|type|required|default value|description| |---|--- |--- |--- |--- | |handleNewUserMessage|(...args: any[]) => any|YES| |Function to handle the user input, will receive the "full text message" when submitted (used for sending)| |handleTextInputChange|(event) => any|YES| |Prop that triggers on input change| |input|string|YES| |user input from the chat enter box, should be a state| |setInput|(event) => any|YES| |same as onKeyPress of an input| |showEmoji|boolean|YES| |whether to enable the emoji functionality| |handleRoomSelect|(event) => any|YES| |triggers when select a new chat room| |currentRoom|string|YES| |the current chat room as a string| |courseChatRooms|string[]|YES| |an array of all the course chat rooms that the user has joined| |privateChatRooms|string[]|YES| |an array of all the personal chat rooms that the user has joined| |handleScrollToTop|() => any|YES| |this function gets called when the chat window is scrolled to the top (used to load new chat history)| |loading|boolean|YES| |if loading is true, scroll position should be the same after adding new messages. If loading is false, scroll position goes to the bottom|

Styles

To change the styles you need the widget to have, simply override the CSS classes wrapping them within the containers and add your own style to them! All classes are prefixed with rcw- so they don't override your other classes in case you are not hasing them. To override, you can do, for expample:

.rcw-conversation-container > .rcw-header {
  background-color: red;
}

.rcw-message > .rcw-response {
  background-color: black;
  color: white;
}

That way, you can leave the JS clean and keep the styles within the CSS.

Messages

As of v3.0, messages now have an optional ID that can be added on creation.If you want to add new messages, you can use the following methods:

• addResponseMessageToTop

  • params:
    • text: string
    • author: string
    • time: string (the time this message was sent)
    • id: string (optional)
  • Method to add a new message to the top of message stack on the left side of the chat window (sent by people other than the user). Used to add message received from server.

• addUserMessageToTop

  • params:
    • text: string
    • author: string
    • time: string (the time this message was sent)
    • id: string (optional)
  • Method to add a new message to the top of message stack on the right side of the chat window (sent by the user). Used to add message received from server.

• addResponseMessageToBottom

  • params:
    • text: string
    • author: string
    • time: string (the time this message was sent)
    • id: string (optional)
  • Method to add a new message to the bottom of message stack on the left side of the chat window (sent by people other than the user). Used to add message received from server.

• addUserMessageToBottom

  • params:
    • text: string
    • author: string
    • time: string (the time this message was sent)
    • id: string (optional)
  • Method to add a new message to the bottom of message stack on the right side of the chat window (sent by the user). Used to add message received from server.

• addLinkSnippet

  • params:
    • link
  • Method to add a link snippet. You need to provide this method with a link object, which must be in the shape of:

    {
      title: 'My awesome link',
      link: 'https://github.com/Wolox/react-chat-widget',
      target: '_blank'
    }

  • By default, target value is _blank which will open the link in a new window.

• renderCustomComponent

  • params:
    • component: Component to be render,
    • props: props the component needs,
    • showAvatar: boolean, default value: false; the component will be rendered with the avatar like the messages
  • Method to render a custom component inside the messages container. With this method, you can add whatever component you need the widget to have.

• setQuickButtons

  • params:
    • buttons: An array of objects with the keys label and value

Markdown is supported for both the responses and user messages.

Widget behavior

You can also control certain actions of the widget:

• toggleWidget

  • params: No params expected
  • This method is to toggle the widget at will without the need to trigger the click event on the launcher

• toggleInputDisabled

  • params: No params expected
  • Method to toggle the availability of the message input for the user to write on

• toggleMsgLoader

  • Toggles the message loader that shows as a "typing..." style.

• dropMessages

  • Simply deletes all the messenges

• deleteMessages*

  • params:
    • count: messages to delete counting from last to first
    • id: message id to delete
  • Delete messages that either have an id you previously set with the addResponseMessage or delete based on position or both of them. For example deleteMessages(2, 'myId') will delete the message that has the id myId and the previous message.

• markAllAsRead

  • Marks all response messages as read. The user messages doesn't have the read/unread property.

• setBadgeCount

  • params:
    • count: number
  • As of v3.0, the badge prop is being changed to be managed from within the Widget. This method is manually set the badge number.

Widget components

Custom Launcher

You can use a custom component for the Launcher if you need one that's not the default, simply use the launcher prop:

import React from 'react';
import { Widget } from 'react-chat-widget';

...

function MyApp() {
  const getCustomLauncher = (handleToggle) =>
    <button onClick={handleToggle}>This is my launcher component!</button>

  return (
    <Widget
      ...
      launcher={handleToggle => getCustomLauncher(handleToggle)}
    />
  )
}

getCustomLauncher() is a method that will return the Launcher component as seen in the example. By default, the function passed by that prop, will receive the handleToggle parameter which is the method that will toggle the widget.

About

This project is maintained by Martín Callegari and it was written by Wolox.