From e8a6411ddd7aab6b5affbf825402d6a943f4515d Mon Sep 17 00:00:00 2001 From: 1on Date: Fri, 22 May 2020 14:21:54 +0300 Subject: [PATCH] Readme updated --- README.md | 147 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 77 insertions(+), 70 deletions(-) diff --git a/README.md b/README.md index e39f372..9672506 100644 --- a/README.md +++ b/README.md @@ -1,84 +1,91 @@ -

VueFormulate

+## What is Vue Formulario? -

- - npm - GitHub - -

+Vue Formulario is a library, based on Vue Formulate, that handling the core logic for working with forms and gives full control of form presentation. -

- Documentation Website -

+## Examples -## What is Vue Formulate? +Every form control must be rendered inside FormularioInput component. This component provides `id` and `context` in v-slot props. Control should use `context.model` as v-model and `context.blurHandler` as handler for `blur` event (it is necessary for validation when property `errorBehavior` is `blur`). Errors list for field can be accessed through `context.allErrors`. -Vue Formulate is the easiest way to build forms with Vue. Please read the [comprehensive documentation](https://vueformulate.com) for live code examples and guidance on using Vue Formulate in your own projects. +Next example creates form for data +```json + { + "username": "", + "password": "", + "options": { + "anonym": false, + "tags": ["test"] + }, + } +``` -

+```html + + + +
+ + {{ error }} + +
+ + + + - - - - - - - - - - - - - - - - -
-

Key features

-
-

😎 Developer happiness

-

Forms are everywhere, yet surprisingly tedious to author — well, not anymore. Vue Formulate provides a powerful and flexible API to developers that makes complex form creation a breeze.

- 		-

☝️ A single input element

-

With Vue Formulate you don't need to remember the names of a dozen components — all form elements are created with a single component. Easy!

-
-

💪 Grouped fields

-

Vue Formulate ships with repeatable field groups out of the box. Create complex UIs such as multi-person booking forms with ease.

- 		-

🎯 Built-in validation

-

Ridiculously easy validation out-of-the-box to handle 95% of use-cases. Help text, validation rules, and validation messages are simple props. Need more? You can add custom validations too.

-
-

🔌 Plugin system

-

Extend Vue Formulate's functionality or reuse custom inputs, validation rules, and messages across projects by tapping into the plugin system. Make your plugin open source to share with others!

- 		-

✨ Generate forms

-

Generate an entire form from a JSON string. Because Vue Formulate uses a single input component, you can easily loop through an array and dynamically generate a form.

-
+ + +
+ + +
+ + - -These features and many more are covered thoroughly at the [documentation website](https://vueformulate.com). - -

- - -## Contributing -Vue Formulate is and always will be _free_ and _open source_. There are many ways available for you to [contribute to Vue Formulate](https://vueformulate.com/guide/contributing/). - -#### Core Codebase Contributors - -This project exists thanks to all the people who volunteer their time to [contribute](https://vueformulate.com/guide/contributing/) - - - -#### Localization Contributors - -Vue Formulate is translated into different languages by volunteer native language speakers. Localizations are located in the [Vue Formulate Internationalization repo](https://github.com/wearebraid/vue-formulate-i18n). - - + + + + +``` ## License [MIT](https://opensource.org/licenses/MIT) +Copyright (c) 2020-present, [RetailDriver LLC]
Copyright (c) 2020-present, [Braid LLC](https://www.wearebraid.com/) \ No newline at end of file