Skip to content
Turning web forms into conversations
HTML CSS JavaScript TypeScript
Branch: master
Clone or download
Latest commit e10e634 Aug 1, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update issue templates second time around Dec 6, 2018
dist New build to mitigate wrong ver num used Jul 29, 2019
docs Merge branch 'master' of github.com:space10-community/conversational-… Aug 1, 2019
gulp-tasks Updated base theme (light, including dark, blue etc.) Jul 15, 2019
landingpage merge Aug 1, 2019
src New build to mitigate wrong ver num used Jul 29, 2019
tests Added theme option to support easy theme change Jul 24, 2019
.bowerrc bower restructure Feb 16, 2017
.gitignore Added landingpage to ignore list Jul 15, 2019
.travis.yml Fixed config per Travis CI XVFB Jul 24, 2019
CONTRIBUTING.md Create CONTRIBUTING.md Dec 6, 2018
LICENSE.md v0.9.81 build - minor bugfixes. May 18, 2018
PULL_REQUEST_TEMPLATE.md Create PULL_REQUEST_TEMPLATE.md Dec 6, 2018
README.md Update README.md Aug 1, 2019
bower.json New build to mitigate wrong ver num used Jul 29, 2019
gulpfile.js Added new TWBS style docs for 0.9.6 Dec 15, 2017
index.html Added the old landingpage. Feb 9, 2018
karma.conf.js fixes #167 Aug 17, 2017
package-lock.json Fixed unmerged conflict from merging branches Jun 4, 2019
package.json

README.md

Conversational Form

Conversational Form is an open-source concept by SPACE10 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.

Introducing Conversational Form 1.0

Explore Conversational Form docs »

Quick Start

Include Conversational Form in your page:

<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/space10-community/conversational-form@1.0.1/dist/conversational-form.min.js" crossorigin></script>

Or download/install the latest release:

  • Clone the repo: git clone https://github.com/space10-community/conversational-form.git
  • Install with npm: npm install conversational-form
  • Install with yarn: yarn add conversational-form

Manually instantiating Conversational Form

import { ConversationalForm } from 'conversational-form';

const cfInstance = new ConversationalForm({
    formEl: formElement,
    context: targetElement,
});

Conversational Form will automatically look through the DOM for a form element with the attribute cf-form, and auto-instantiate.

<form id="my-form-element" cf-form>
...
</form>

Read the Getting started page for information on the framework contents, options, templates, examples and more.

Status

npm version Build Status JS gzip size CSS gzip size

Bugs and feature requests

If you see a bug, have an issue or a feature request then please submit an issue in theGitHub issue tracker. For the sake of efficiency we urge you to look through open and closed issues before opening a new issue. Thank you ⭐

Documentation

Conversational Form's documentation is included in /docs of this repo as well as being hosted on GitHub Pages.

Contributing

Pull Requests for bug fixes or new features are always welcome. If you choose to do a Pull Request please keep these guidelines in mind:

  • Fork the "develop" branch
  • If you forked a while ago please get the latest changes from the "develop"-branch before submitting a Pull Request
    • Locally merge (or rebase) the upstream development branch into your topic branch:
      • git remote add upstream https://github.com/space10-community/conversational-form.git
      • git checkout develop
      • git pull upstream
      • git pull [--rebase] upstream develop
  • Always create new Pull Request against the "develop" branch
  • Add a clear title and description as well as relevant references to open issues in your Pull Request

Versioning

See the Releases section of our GitHub project for changelogs for each release version of Conversational Form. We will do our best to summarize noteworthy changes made in each release.

Acknowledgement

Thank you to everyone who has taken part in the creation of Conversational Form.

Copyright and license

Conversational Form is licensed under MIT. Documentation under CC BY 3.0.

You can’t perform that action at this time.