React Simple Chatbot

A simple chatbot component to create conversation chats

Contents

• Getting Started
• Usage
• Documentation
  • Properties
  • Steps
  • Custom Component
• How to Contribute

Getting Start

npm install react-simple-chatbot --save

Usage

There are several examples on the website. Here is the first one to get you started:

import ChatBot from 'react-simple-chatbot';

const steps = [
  {
    id: '0',
    message: 'Welcome to react chatbot!',
    trigger: '1',
  },
  {
    id: '1',
    message: 'Bye!',
    end: true,
  },
];

ReactDOM.render(
  <div>
    <ChatBot steps={steps} />
  </div>,
  document.getElementById('root')
);

Build with react-simple-chatbot

1. Seth Loh Website - Personal website of Seth Loh (demo)

Documentation

Properties

Name	Type	Default	Description
avatarStyle	PropTypes.object		The style object to use to override the avatar element
botAvatar	PropTypes.string	img	Bot image source
botDelay	PropTypes.number	1000	The delay time of bot messages
bubbleStyle	PropTypes.object		The style object to use to override the bubble element
cache	PropTypes.bool	false	Rendered steps will be cached in localStorage. The cache will be clean automatically when you get the final step. Also, you can do it manually using localStorage.removeItem('rsc_cache')
className	PropTypes.string		Add a class name to root element
contentStyle	PropTypes.object		The style object to use to override the scroll element
customDelay	PropTypes.number	1000	The delay time of custom messages
customStyle	PropTypes.object		The style object to use to override the custom step element
floating	PropTypes.bool	false	Render chatbot with a floating button
footerStyle	PropTypes.object		The style object to use to override the footer element
handleEnd({ renderedSteps, steps, values })	PropTypes.func		The callback function when chat ends
headerBgColor	PropTypes.string	#6e48aa	Backgroud color of header element
headerComponent	PropTypes.element		Override the default header element
headerFontColor	PropTypes.string	#fff	Font color of header element
headerTitle	PropTypes.string	Chat	Override header title
hideBotAvatar	PropTypes.bool	false	If true the bot avatar will be hidden in all steps
hideHeader	PropTypes.bool	false	If true the header will be hidden
hideSubmitButton	PropTypes.bool	false	IIf true the submit button will be hidden
hideUserAvatar	PropTypes.bool	false	If true the user avatar will be hidden in all steps
inputStyle	PropTypes.object		The style object to use to override the input element
opened	PropTypes.bool	undefined	Override the default opened state. This prop can just be used if floating is true. You must use the callback prop toggleFloating to update the opened prop
placeholder	PropTypes.string	Type the message ...	Chatbot input placeholder
steps	PropTypes.array		The chatbot steps to display
style	PropTypes.object		The style object to use to override the submit button element
submitButtonStyle	PropTypes.object		The style object to use to override the root element
toggleFloating	PropTypes.func	undefined	Must be used with opened prop. You must use it to change your opened prop using your custom function like myToggleFloating({ opened })
userAvatar	PropTypes.string	img	User image source
userDelay	PropTypes.number	1000	The delay time of user messages

Steps

Text Step

Name	Type	Required	Description
id	String / Number	true	The step id. Required for any step
message	String	true	The text message
trigger	String / Number	false	The id of next step to be triggered
avatar	String	false	the avatar to be showed just in this step. Note: this step must be a step that avatar appears
delay	Number	false	set the delay time to message be shown
end	Boolean	false	if true indicate that this step is the last

Example:

{
  id: '1',
  message: 'Hello World',
  end: true,
}

User Step

Name	Type	Required	Description
id	String / Number	true	The step id. Required for any step
user	Boolean	true	if true indicate that you waiting a user type action
trigger	String / Number	false	The id of next step to be triggered
validator	String / Number	false	if user attribute is true you can pass a validator function to validate the text typed by the user
end	Boolean	false	if true indicate that this step is the last

Example:

{
  id: '1',
  user: true,
  end: true,
}

Options Step

Name	Type	Required	Description
id	String / Number	true	The step id. Required for any step
options	Array	true	Array of options with { label, value, trigger } properties
end	Boolean	false	if true indicate that this step is the last

Example:

{
  id: '1',
  options: [
    { value: 1, label: 'Number 1', trigger: '3' },
    { value: 2, label: 'Number 2', trigger: '2' },
    { value: 3, label: 'Number 3', trigger: '2' },
  ],
}

Custom Step

Name	Type	Required	Description
id	String / Number	true	The step id. Required for any step
component	Component	true	Custom React Component
replace	Boolean	false	if true indicate that component will be replaced by the next step
waitAction	Boolean	false	if true indicate that you waiting some action. You must use the triggerNextStep prop in your component to execute the action
asMessage	Boolean	false	f true indicate that the component will be displayed as a text step
trigger	String / Number	false	The id of next step to be triggered
delay	Number	false	set the delay time to component be shown
end	Boolean	false	if true indicate that this step is the last

Example:

{
  id: '1',
  component: <CustomComponent />
  trigger: '2'
}

Update Step

Name	Type	Required	Description
id	String / Number	true	The step id. Required for any step
update	String / Number	true	The id of next step to be updated
trigger	String / Number	false	The id of next step to be triggered

Example:

{
  id: '1',
  options: [
    { value: 1, label: 'Number 1', trigger: '3' },
    { value: 2, label: 'Number 2', trigger: '2' },
    { value: 3, label: 'Number 3', trigger: '2' },
  ],
}

Custom Component

When you declare a custom step, you need indicate a custom React Component to be rendered in the chat. This custom component will receive the following properties.

Name	Type	Description
previousStep	PropTypes.object	Previous step rendered
step	PropTypes.object	Current step rendered
steps	PropTypes.object	All steps rendered
triggerNextStep({ value, trigger })	PropTypes.func	Callback function to trigger next step when user attribute is true. Optionally you can pass a object with value to be setted in the step and the next step to be triggered

How to Contribute

Please check the contributing guide

Authors

Lucas Bassetti

See also the list of contributors who participated in this project.

Donate

If you liked this project, you can donate to support it ❤️

License

MIT · Lucas Bassetti