react-chat-window2

react-chat-window

react-chat-window provides an intercom-like chat window that can be included easily in any project for free. It provides no messaging facilities, only the view component.

This project is fuelled by donations and maple syrup:

Features

• Customizeable
• Backend agnostic
• Free

Demo

Table of Contents

• Installation
• Example
• Components

Installation

$ npm install react-chat-window

Example

import React, {Component} from 'react'
import {Launcher} from 'react-chat-window'

class Demo extends Component {

  constructor() {
    super();
    this.state = {
      messageList: []
    };
  }

  _onMessageWasSent(message) {
    this.setState({
      messageList: [...this.state.messageList, message]
    })
  }

  _sendMessage(text) {
    if (text.length > 0) {
      this.setState({
        messageList: [...this.state.messageList, {
          author: 'them',
          type: 'text',
          data: { text }
        }]
      })
    }
  }

  render() {
    return (<div>
      <Launcher
        agentProfile={{
          teamName: 'react-chat-window',
          imageUrl: 'https://a.slack-edge.com/66f9/img/avatars-teams/ava_0001-34.png'
        }}
        onMessageWasSent={this._onMessageWasSent.bind(this)}
        messageList={this.state.messageList}
        showEmoji
      />
    </div>)
  }
}

For more detailed examples see the demo folder.

Components

Launcher

Launcher is the only component needed to use react-chat-window. It will react dynamically to changes in messages. All new messages must be added via a change in props as shown in the example.

Launcher props:

prop	type	required	description
agentProfile	object	yes	Represents your product or service's customer service agent. Fields: imageUrl (string), teamName (string).
handleClick	function	yes	Intercept the click event on the launcher. No argument sent when function is called.
isOpen	boolean	yes	Force the open/close state of the chat window. If this is not set, it will open and close when clicked.
messageList	[message]	yes	An array of message objects to be rendered as a conversation.
mute	boolean	no	Don't play sound for incoming messages. Defaults to false.
newMessagesCount	number	no	The number of new messages. If greater than 0, this number will be displayed in a badge on the launcher. Defaults to 0.
onFilesSelected	function(fileList)	no	Called after file has been selected from dialogue in chat window.
onMessageWasSent	function(message)	yes	Called when a message is sent, with a message object as an argument.
showEmoji	boolean	no	Whether or not to show the emoji button in the input bar. Defaults to true.

Message Objects

Message objects are rendered differently depending on their type. Currently, only text, file, and emoji types are supported. Each message object has an author field which can have the value 'me' or 'them'.

{
  author: 'them',
  type: 'text',
  data: {
    text: 'some text'
  }
}

{
  author: 'me',
  type: 'emoji',
  data: {
    code: 'someCode'
  }
}


{
  author: 'me',
  type: 'file',
  data: {
    url: 'somefile.mp3',
    fileName: 'Any old name'
  }
}

{
  author: 'me',
  type: 'image',
  data: {
    url: 'somefile.png',
    fileName: 'Any name.png'
  }
}

Agent Profile Objects

Look like this:

{
  imageUrl: 'https://somewhere.on/the_web.png',
  teamName: 'Da best'
}

People Using react-chat-window

If you're using react-chat-window in a product I'd love to see what you're making! Email me at [e-mail]