Skip to content

Latest commit

 

History

History
96 lines (75 loc) · 3.1 KB

README.md

File metadata and controls

96 lines (75 loc) · 3.1 KB
Raw

Flow Chat JS Plugin

Build Status

License

A Javascript plugin to help developers build simple conversational chat flow.

Demos

Flow Chat Demo

Usage

Include With Vanilla JS

  1. Include JQuery
  2. Include the main script and
  3. target elements using JS notation:
<script src="https://code.jquery.com/jquery-3.4.1.min.js"></script>
<script src="textblock.min.js"></script>

<script>
  $('#flowchat').flowchat({
    data: false, // require a JSON to be passed
    delay: 1500,
    startButtonId: '#startButton',
    autoStart: true,
    startMessageId: 1
  });
</script>

Parameters

  • data (required): default false. Data should be passed as a JSON. Check format of the JSON below.
  • delay: default '1500'ms. This allows you to add a time delay to simulate typing before the bot messages.
  • startButtonId: default #startButton. You can define a start button id. Clicking this button will restart the chat flow.
  • autoStart: default true. If true, the chat flow will start as soon as the page load. If you need to delay the start, set it to 'false'
  • startMessageId: default 1. Change if you wish to start from a different message id.

JSON format

I have included as .tsv file as a demo. You can modify the TSV, covert it to a JSON, and use.

This is the format for a single message.

[{
    "id": 1,
    "text": "How are you?",
    "messageType": "Question",
    "imageUrl": "",
    "nextMessageId": "",
    "option1": "I'm fine",
    "option1_nextMessageId": 2,
    "option2": "Not too great",
    "option2_nextMessageId": 3
  },
  {
    "id": 2,
    "text": "That's good! Keep up the optimism.",
    "messageType": "Text",
    "imageUrl": "",
    "nextMessageId": ""
  },
  {
    "id": 3,
    "text": "That's too bad. Hope things get better for you soon.",
    "messageType": "Text",
    "imageUrl": "",
    "nextMessageId": ""
  }
, { "id": 4, ... }, .... { "id": 45, ...} ]
  • id (required): This is the message id. Should be kept unique.
  • text: The message to be sent.
  • messageType: Currently supports TEXT, and QUESTION. If QUESTION, then options will be presented to the user.
  • nextMessageId: If type of message is TEXT, then the next message based on this field will be auto-triggered.
  • option1: If type is a "Question", then option text will be shown to the user to select as input.
  • option1_nextMessageId: If user selects option 1, then the id of the next message to be sent.

Add Upto 6 options for each message. For TEXT messages you can skip adding options entirely.

You can add as many message as you like and chain them together. The conversation will end when there is no "nextMessageId"

Future Scope

  • Image and GIF support
  • URL message support
  • Designing options - background image, etc.
  • TSV to JSON converter
  • Link to Google Spreadsheet to pull data