RetailCRM-Mirror/vue-formulario
1
0
Fork 0
mirror of synced 2024-11-25 14:56:03 +03:00
Code Issues Projects Releases Wiki Activity

Merge pull request #24 from wearebraid/feature/updated-readme

Browse Source 
Feature/updated readme
This commit is contained in:
Justin Schroeder 2020-03-08 13:47:05 -04:00 committed by GitHub
commit 54f2c66b91
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -14,10 +14,15 @@
### What is Vue Formulate? ### What is Vue Formulate?
Vue Formulate is the easiest way to build forms using Vue. Key features include Vue Formulate is the easiest way to build forms using Vue. Key features include
form and field validation, file uploads, form generation and a single-element form and field validation, file uploads, form generation, single-element inputs that support labels, help text, error messages, placeholders and more, and [comprehensive documentation](https://vueformulate.com) for use within your own projects.
fields with labels, help text, error messages, placeholders and lots more.
The syntax is what developers would expect: v-model an entire form | Well-considered file uploads
:-------------------------:|:------------------------------:
![v-model an entire form](https://assets.wearebraid.com/vue-formulate/formulate-form.gif) | ![well-considered file uploads](https://assets.wearebraid.com/vue-formulate/formulate-uploads.gif)
### How is Vue Formulate used?
The syntax is what developers would expect. To create an input you use the `FormulateInput` element and provide it with a few props:
```vue ```vue
<FormulateInput <FormulateInput
@ -30,15 +35,18 @@ The syntax is what developers would expect:
/> />
``` ```
Collecting multiple `FormulateInput` elements within a single `FormulateForm` element (even deeply nested) allows you to `v-model` your entire form.
### Vue Formulate lets you:
✓ Create any input element with a single component<br> ✓ Create any input element with a single component<br>
✓ Supports Vue `v-model` [binding](https://vueformulate.com/guide/#model-binding)<br> ✓ Use `v-model` [binding](https://vueformulate.com/guide/#model-binding) on fields and entire forms<br>
✓ [Re-populate an entire form](https://vueformulate.com//guide/forms/#setting-initial-values) from a single object<br> ✓ [Re-populate an entire form](https://vueformulate.com//guide/forms/#setting-initial-values) from a single object<br>
✓ [Generate a form](https://vueformulate.com//guide/forms/#generating-forms) using json<br> ✓ [Generate a form](https://vueformulate.com//guide/forms/#generating-forms) using json<br>
✓ Easy to add field labels<br> ✓ Easily add field labels<br>
✓ Easy to add help text<br> ✓ Easily add help text<br>
✓ Easy to add [form validation](https://vueformulate.com//guide/validation)<br> ✓ Easily add [form validation](https://vueformulate.com//guide/validation)<br>
✓ Easy to add [custom validation](https://vueformulate.com//guide/validation/#custom-validation-rules) rules<br> ✓ Easily add [custom validation](https://vueformulate.com//guide/validation/#custom-validation-rules) rules<br>
✓ Easy to modify [validation messages](https://vueformulate.com//guide/validation/#customize-validation-messages)<br> ✓ Easily create custom [validation messages](https://vueformulate.com//guide/validation/#customize-validation-messages)<br>
✓ Easy to add [custom inputs](https://vueformulate.com//guide/custom-inputs) ✓ Easily create [custom inputs](https://vueformulate.com//guide/custom-inputs)
There's a lot more available to read at the [documentation website](https://vueformulate.com). There's a lot more available to read at the comprehensive [documentation website](https://vueformulate.com).