https://github.com/alexgurr/react-conversation-form

A React wrapper/version for Space10's Conversational Form - https://github.com/space10-community/conversational-form
https://github.com/alexgurr/react-conversation-form

answers chat conversation conversational conversational-form form questions react react-conversational-form space10

Last synced: 3 months ago
JSON representation

A React wrapper/version for Space10's Conversational Form - https://github.com/space10-community/conversational-form

• Host: GitHub
• URL: https://github.com/alexgurr/react-conversation-form
• Owner: alexgurr
• Created: 2017-11-01T16:15:00.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2022-12-07T18:25:33.000Z (almost 3 years ago)
• Last Synced: 2024-10-14T06:21:23.346Z (12 months ago)
• Topics: answers, chat, conversation, conversational, conversational-form, form, questions, react, react-conversational-form, space10
• Language: JavaScript
• Homepage:
• Size: 1.19 MB
• Stars: 17
• Watchers: 2
• Forks: 7
• Open Issues: 12
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# react-conversation-form · [![npm](https://img.shields.io/npm/v/react-conversation-form.svg?style=flat-square)](https://www.npmjs.com/package/react-conversation-form)   [![npm](https://img.shields.io/npm/dt/react-conversation-form.svg?style=flat-square)]()

A React wrapper for Conversational Form (https://github.com/space10-community/conversational-form).

## Table of Contents

- [Installation](#installation)

- [Usage](#usage)

- [Options](#options)

- [ToDo](#todo)

## Installation

`npm install react-conversation-form --save`

or 

`yarn add react-conversation-form`

## Usage

For Example (Feedback Form):

     import { Conversation, Select, Question, Option } from 'react-conversation-form';

     // const { Conversation, Select, Question, Option } = require('react-conversation-form');

     

      {}}

          chatOptions={{

              thankTheUser: ['identifier', 'feedbackType'],

              introText: 'Hi there. Lets leave some feedback! To edit any of your responses, just click on them.',

              submitText: 'Thanks for giving us your feedback!'

          }}

      >

          

              Issue

              Typo

              Praise

              Other

          

           text.includes('@')}>

              {'What\'s your company email address, so we can identify you?'}

          

          

              What are you thinking?

          

      

  

## Options

### Conversation

* `onSubmit` - *function* Callback function for the form contents when the user has finished (**required**)

* `chatOptions` - *object* Extra options for the chat `default: {}`

    * `robotResponseTime` - *number* The time (ms) the robot takes before responding

    * `robotChainResponseTime` - *number* The time (ms) the robot takes between chained messages

    * `showUserThinking` - *boolean* Whether to show the user writing '...' while waiting for response

    * `robotChainResponseTime` - *number* The time (ms) the robot takes between chained messages

    * `thankTheUser` - *array* Array of question IDs that the bot should thank the user after answering

    * `introText` - *string* The opening message from the bot

    * `submittedResponseText` - *string* Closing response message from the bot

### Question

### Select

### Option

## ToDo:

- Expose icons and all configuration options through props (only subset currently supported)

- Fix tests