Skip to content

Commit 6149159

Browse files
committed
Merge branch 'develop'
2 parents d3a1906 + 1ebbed7 commit 6149159

File tree

7 files changed

+73
-271
lines changed

7 files changed

+73
-271
lines changed

README.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,47 @@
11
# Conversational Form
22

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.
44

55
<p align="center">
66
<a href="https://medium.com/conversational-interfaces/introducing-the-conversational-form-c3166eb2ee2f#.yq5axcfcq"><strong>Learn why we did it</strong></a>
77
</p>
88
<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>
1010
</p>
1111
<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" />
1313
</p>
1414

1515
## Quick Start
1616

17-
Include ConversationalForm in your page:
17+
Include Conversational Form in your page:
1818

1919
```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>
2121
```
22-
Or download the latest release:
22+
Or download/install the latest release:
2323
- Clone the repo: ````git clone https://github.com/space10-community/conversational-form.git````
2424
- Install with npm: ````npm install conversational-form````
2525
- Install with yarn: ````yarn add conversational-form````
2626

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.
2838
```html
2939
<form id="my-form-element" cf-form>
3040
...
3141
</form>
3242
```
3343

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.
3745

3846
## Status
3947
[![npm version](https://img.shields.io/npm/v/conversational-form.svg)](https://www.npmjs.com/package/conversational-form)

docs/1.0.0/getting-started/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ <h1 id="getting-started">Getting Started</h1>
136136
<p>Turning web forms into conversations. Conversational Form is an open-source concept by <a href="https://space10.io/" target="_blank">SPACE10</a> 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.</p>
137137

138138
<h2 id="include-conversationalform-in-your-page">Include ConversationalForm in your page</h2>
139-
<pre><code class="language-html" data-lang="html">&lt;script type="text/javascript" src="https://cdn.jsdelivr.net/gh/space10-community/conversational-form@1.0.0/dist/conversational-form.min.js" crossorigin>&lt;/script></code></pre>
139+
<pre><code class="language-html" data-lang="html">&lt;script type="text/javascript" src="https://cdn.jsdelivr.net/gh/space10-community/conversational-form@1.0.1/dist/conversational-form.min.js" crossorigin>&lt;/script></code></pre>
140140

141141
<p>ConversationalForm will automatically look through the DOM for a form element with the attibute cf-form, and auto-instantiate.</p>
142142
<pre><code class="language-html" data-lang="html">&lt;form id="my-form-element" cf-form ...></code></pre>

docs/1.0.0/src/pages/getting-started/index.twig

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<p>Turning web forms into conversations. Conversational Form is an open-source concept by <a href="https://space10.io/" target="_blank">SPACE10</a> 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.</p>
99

1010
<h2 id="include-conversationalform-in-your-page">Include ConversationalForm in your page</h2>
11-
<pre><code class="language-html" data-lang="html">&lt;script type="text/javascript" src="https://cdn.jsdelivr.net/gh/space10-community/conversational-form@{{nextVersion}}/dist/conversational-form.min.js" crossorigin>&lt;/script></code></pre>
11+
<pre><code class="language-html" data-lang="html">&lt;script type="text/javascript" src="https://cdn.jsdelivr.net/gh/space10-community/conversational-form@1.0.1/dist/conversational-form.min.js" crossorigin>&lt;/script></code></pre>
1212

1313
<p>ConversationalForm will automatically look through the DOM for a form element with the attibute cf-form, and auto-instantiate.</p>
1414
<pre><code class="language-html" data-lang="html">&lt;form id="my-form-element" cf-form ...></code></pre>

0 commit comments

Comments
 (0)