Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/formvuelate/formvuelate
Dynamic schema-based form rendering for VueJS
https://github.com/formvuelate/formvuelate
form-builder forms javascript javascript-library schema vue vuejs
Last synced: 12 days ago
JSON representation
Dynamic schema-based form rendering for VueJS
- Host: GitHub
- URL: https://github.com/formvuelate/formvuelate
- Owner: formvuelate
- License: mit
- Archived: true
- Created: 2019-04-08T15:51:29.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-02-04T11:56:13.000Z (almost 2 years ago)
- Last Synced: 2024-10-28T17:21:04.218Z (16 days ago)
- Topics: form-builder, forms, javascript, javascript-library, schema, vue, vuejs
- Language: JavaScript
- Homepage: https://formvuelate.js.org
- Size: 6.18 MB
- Stars: 445
- Watchers: 7
- Forks: 41
- Open Issues: 32
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# FormVueLate
## ⚠️ IMPORTANT ⚠️
It makes us very sad but as of June 2022 this repository is officially unmaintained.
We do not have the required time and space to make the updates it needs to grow, and the possibly necessary rewrite to bring in new and better features.
If anyone wishes to take over and continue with the project, please ping Marina on twitter.com/marinamosti
[](https://www.npmjs.com/package/formvuelate)
[](https://codecov.io/gh/formvuelate/formvuelate)
[](https://plant.treeware.earth/formvuelate/formvuelate)
Visit [FormVueLate 3.0's full documentation](https://formvuelate.js.org/#getting-started) for more detailed information and examples.
## Getting Started
FormVueLate is a zero dependency library that allows you to generate schema-driven forms with extreme ease.
The schema that you use for your form can be as flexible as you need it to be, it can be modified at run-time with an expected reactive result, and can even be fetched directly from you backend’s API.
**Important**
FormVueLate is a bring-your-own-components library!
We do _not_ provide any base components for your to build your forms. There are numerous component libraries out there that do a great job of providing carefully constructed components for you to use, and FormVueLate does a great job at allowing you to bring those external components to your forms, or even crafting your own.
### FormVueLate 2.x
The docs for FormVueLate 2.x can be found [here](https://formvuelate-2x.netlify.app/)
## Installation
To add FormVueLate to your project, start by installing the package through your favorite package manager.
```bash
yarn add formvuelate
// OR
npm install formvuelate
```
## Using the SchemaForm component
Now that you have the package in your project, `import` it to your component.
```javascript
import { SchemaForm, useSchemaForm } from 'formvuelate'
```
The `SchemaForm` requires one `prop`, `schema`, which is the meta-data of your form. You must also import the `useSchemaForm` composable which we will use in our setup function to initialize the form's `model` where the user's data is kept.
```html
import { ref } from 'vue'
import { SchemaForm, useSchemaForm } from 'formvuelate'
export default {
components: { SchemaForm },
setup () {
const formModel = ref({})
useSchemaForm(formModel)
const mySchema = ref({
// Schema here
})
return {
mySchema
}
}
}
```
`SchemaForm` will automatically update the state within your `formModel` when your components update.
## Official plugins
#### Lookup Plugin
A mapping and replacement plugin to parse complex schemas into FormVueLate ready structure.
#### Vee-Validate Plugin
Easily incporate Vee-Validate powered validations into your forms.
#### Vuelidate Plugin WIP
Easily incorporate Vuelidate powered validations into your forms.
## Core team
## Emeriti
Special thanks to these folks which have provided invaluable contributions to the project.
## Licence and Support
This package is [Treeware](https://treeware.earth). If you use it in production, then we ask that you [**buy the world a tree**](https://plant.treeware.earth/formvuelate/formvuelate) to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.
If you want to use paypal, you can make any donations to [Marina's Paypal account](https://www.paypal.com/paypalme/mostimarina). All donations recieved here will go directly into buying more trees as well!