|
1 |
| -# vue-form-generator |
| 1 | +# vue-form-generator [](https://www.npmjs.com/package/vue-form-generator) |
2 | 2 | A schema-based form generator component for Vue.js
|
3 | 3 |
|
| 4 | +[](https://www.npmjs.com/package/vue-form-generator) |
| 5 | + |
4 | 6 | ## Demo
|
5 | 7 | [JSFiddle simple example](https://jsfiddle.net/icebob/0mg1v81e/)
|
6 | 8 |
|
7 | 9 | ## Features
|
8 |
| -TODO |
| 10 | +- multiple objects editing |
| 11 | +- 18 built-in field types |
| 12 | +- built-in validations |
| 13 | +- Bootstrap friendly templates |
| 14 | +- ...etc |
9 | 15 |
|
10 | 16 | ## Dependencies
|
11 |
| -TODO |
| 17 | +- [jQuery](http://www.jquery.com) |
| 18 | +- [Moment.js](http://momentjs.com/) (built-in) |
| 19 | +- [lodash](https://lodash.com/) (built-in) |
| 20 | +- [BootStrap](http://getbootstrap.com/) (optional) |
| 21 | +- [bootstrap-select](https://silviomoreto.github.io/bootstrap-select/) for `selectEx` fields (optional) |
| 22 | +- [bootstrap-datetimepicker](https://github.com/Eonasdan/bootstrap-datetimepicker) for `datetime` fields (optional) |
| 23 | +- [spectrum](https://github.com/bgrins/spectrum) for `spectrum` color picker fields (optional) |
| 24 | +- [maskedinput](http://digitalbush.com/projects/masked-input-plugin/) for `masked` fields |
12 | 25 |
|
13 | 26 | ## Installation
|
14 | 27 | ### NPM
|
15 |
| -TODO |
16 |
| - |
| 28 | +Installation uses the [npm](http://npmjs.org/) package manager. Just type the following command after installing npm. |
| 29 | +``` |
| 30 | +$ npm install vue-form-generator |
| 31 | +``` |
17 | 32 | ### Manual
|
18 |
| -TODO |
| 33 | +Download zip package and unpack and add the `vue-form-generator.js` or `vue-form-generator.min.js` file to your project from dist folder. |
| 34 | +``` |
| 35 | +https://github.com/icebob/vue-form-generator/archive/master.zip |
| 36 | +``` |
19 | 37 |
|
20 | 38 | ## Usage
|
21 | 39 | TODO
|
|
45 | 63 | * [ ] Groupable fields
|
46 | 64 | * [ ] Validation handling with multiple models
|
47 | 65 | * [ ] Bundle for vendor files
|
| 66 | +* [ ] Unit tests, coverage and CI |
48 | 67 |
|
49 | 68 | ## License
|
50 | 69 | vue-form-generator is available under the [MIT license](https://tldrlegal.com/license/mit-license).
|
|
0 commit comments