|
1 | 1 | # Conversational Form |
2 | 2 |
|
3 | | -**Turning web forms into conversations.** Conversational Form is an open-source concept by [SPACE10](https://www.space10.io) to easily turn any form element on a web page into a conversational form interface. It features conversational replacement of all input elements, reusable variables from previous questions and complete customization and control over the styling. |
| 3 | +Conversational Form is an open-source concept by [SPACE10](https://www.space10.io) to easily turn your content into conversations. It features conversational replacement of all input elements, reusable variables from previous questions and complete customization and control over the styling. |
4 | 4 |
|
5 | 5 | <p align="center"> |
6 | 6 | <a href="https://medium.com/conversational-interfaces/introducing-the-conversational-form-c3166eb2ee2f#.yq5axcfcq"><strong>Learn why we did it</strong></a> |
7 | 7 | </p> |
8 | 8 | <p align="center"> |
9 | | - <a href="https://space10-community.github.io/conversational-form/docs/0.9.90/"><strong>Explore Conversational Form docs »</strong></a> |
| 9 | + <a href="https://space10-community.github.io/conversational-form/docs/1.0.0/"><strong>Explore Conversational Form docs »</strong></a> |
10 | 10 | </p> |
11 | 11 | <p align="center"> |
12 | | - <img src="https://raw.githubusercontent.com/space10-community/conversational-form/master/docs/0.9.70/assets/readme-cf.gif" /> |
| 12 | + <img src="https://raw.githubusercontent.com/space10-community/conversational-form/dist/docs/1.0.0/assets/cf-demo.gif" /> |
13 | 13 | </p> |
14 | 14 |
|
15 | 15 | ## Quick Start |
16 | 16 |
|
17 | | -Include ConversationalForm in your page: |
| 17 | +Include Conversational Form in your page: |
18 | 18 |
|
19 | 19 | ```html |
20 | | -<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/space10-community/conversational-form@0.9.90/dist/conversational-form.min.js" crossorigin></script> |
| 20 | +<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/space10-community/conversational-form@1.0.1/dist/conversational-form.min.js" crossorigin></script> |
21 | 21 | ``` |
22 | | -Or download the latest release: |
| 22 | +Or download/install the latest release: |
23 | 23 | - Clone the repo: ````git clone https://github.com/space10-community/conversational-form.git```` |
24 | 24 | - Install with npm: ````npm install conversational-form```` |
25 | 25 | - Install with yarn: ````yarn add conversational-form```` |
26 | 26 |
|
27 | | -ConversationalForm will automatically look through the DOM for a form element with the attribute `cf-form`, and auto-instantiate. |
| 27 | +Manually instantiating Conversational Form |
| 28 | +``` |
| 29 | +import { ConversationalForm } from 'conversational-form'; |
| 30 | +
|
| 31 | +const cfInstance = new ConversationalForm({ |
| 32 | + formEl: formElement, |
| 33 | + context: targetElement, |
| 34 | +}); |
| 35 | +``` |
| 36 | + |
| 37 | +Conversational Form will automatically look through the DOM for a form element with the attribute `cf-form`, and auto-instantiate. |
28 | 38 | ```html |
29 | 39 | <form id="my-form-element" cf-form> |
30 | 40 | ... |
31 | 41 | </form> |
32 | 42 | ``` |
33 | 43 |
|
34 | | -[jsbin](https://jsbin.com/vopuxukaze/edit?html,js,output) |
35 | | - |
36 | | -Read the [Getting started](https://space10-community.github.io/conversational-form/docs/0.9.90/getting-started/) page for information on the framework contents, options, templates and examples and more. |
| 44 | +Read the [Getting started](https://space10-community.github.io/conversational-form/docs/1.0.0/getting-started/) page for information on the framework contents, options, templates, examples and more. |
37 | 45 |
|
38 | 46 | ## Status |
39 | 47 | [](https://www.npmjs.com/package/conversational-form) |
|
0 commit comments