# Vue 3 Form Wizard
[](/templates/LICENSE.md)
[](https://v3.vuejs.org/)
[](https://www.typescriptlang.org/)
[](https://jestjs.io/en/)
[](https://github.com/Anivive/vue-package-starter)
## Introduction
Vue 3 Form Wizard is a JSON configurable, fully customizable, form builder that allows developers to easily create step-based forms.
Form questions can be generated easily by specifying a JSON configuration object. The end result is a step-based form which will display one question at a time.
Support for the most common input types
- Text Input
- Textarea
- Dropdown (filterable)
- Single and Multi Select Options List
- Ability to create your own custom input types
### Features
* Fully customizable style
* Validation of input on a per-step basis
* Custom validation messages
* Ability to query API to get list options
* Callbacks after each question
---
## Table of Contents
* [Introduction](#introduction)
* [Usage](#usage)
* [Documentation](#documentation)
* [Table of Contents](#table-of-contents)
* [Contributing Guidelines](#contributing-guidelines)
* [Code Of Conduct](#code-of-conduct)
* [Bugs and Feature Requests](#bugs-and-feature-requests)
* [Copyright and License](#copyright-and-license)
---
## Usage
Install the package using the node package manager.
```npm
npm install vue3-form-wizard
```
import onto your component and add to the `components` key.
```js
import VueFormWizard from 'vue3-form-wizard'
// If you want to use our styling
import 'vue3-form-wizard/dist/index.css';
export default {
components: {
VueFormWizard
}
}
```
You can then add the component to your template, where the `form` property is an array of objects for generating the form and `v-model` is where to store the data on your component.
```html
```
The `form` property can be configured with objects for each input type very easily:
```json
[
{
"property": "text",
"text": "This is a simple text input question. (Min 3 chars, required)",
"type": "input",
"options": {
"type": "text",
"validations": {
"min": {
"value": 3,
"message": "Input needs to be at least 3 characters"
},
},
"placeholder": "Enter the text."
},
"required": true
},
...
]
```
---
## Documentation
Full documentation can be found [here](https://expert-giggle-ffac66c9.pages.github.io/).
---
## Coming Soon
**Summary view** - Will summarize the user input and allow a quick edit functionality.
**Progress indicator** - This will visually indicate to the user the progress through the form.
**Conditions** - An additional configurable item which will allow for dynamic form generation, based on the answers given, new inputs can be added to the sequence.
**Custom Components** - We also plan to make some out-of-the-box custom components, like a date selector.
---
## Contributing Guidelines
Please read through our [contributing guidelines](CONTRIBUTING.md). Included are directions
for opening issues, coding standards, and notes on development.
Moreover, if your pull request contains JavaScript patches or features, you must include relevant
unit tests. All HTML and CSS should conform to the Code Guide, maintained by Mark Otto.
---
## Code Of Conduct
Please read through our [code of conduct](CODE_OF_CONDUCT.md).
---
## Bugs and Feature Requests
Found a bug or have a feature request? Please first read the issue guidelines and search for
existing and closed issues.
If your problem or idea is not addressed yet, please
[open a new issue](https://github.com/Anivive/vue3-form-wizard/issues).
## Thanks
Thank you to all of you who have contributed to this package.
[[Contribute to the Project](CONTRIBUTING.md)]
## Copyright and License
Code and documentation copyright 2021 Anivive Lifesciences Code released under the [MIT License](LICENSE.md).
Docs released under [Creative Commons](https://creativecommons.org/licenses/by/3.0/).
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md).
By participating in this project you agree to abide by its terms.
---
Status badges created using [Shields.io](https://github.com/badges/shields).