Introduction

vue-form-json-schema

Search…

Introduction

Installation

Getting started

API

Introduction

A JSON schema based form generator, bring your components!
Use any Vue component or HTML element!
There are no prebuilt components for you to puzzle your form together with. Instead you can use any component or element which emits an event, custom or native.
Note that essentially all Vue components that uses v-model emits an input (or similar) event. See Vue's guide for more info​
Installation
Upgrading from v1? Check out the v2 release notes to see if and how migration affects you.
Install from npm
npm install vue-form-json-schema
Import to your app
1
import Vue from 'vue';
2
import VueFormJsonSchema from 'vue-form-json-schema';
3
​
4
Vue.component('vue-form-json-schema', VueFormJsonSchema);
Copied!
Check out the demos or see a minimal example in the usage instructions to get started.
UMD
If you're using the UMD version you can find more examples in the examples folder of the github repo and the UMD demo below.
If you want to use vue-form-json-schema directly in a browser you can do so by using the UMD version. The UMD version autoinstalls the vue-form-json-schema component if Vue is found on the window. The entire module is also available on window.VueFormJsonSchema where the named exports such as for example vfjsFieldMixin can be accessed.
Hosted by unkpg
<script src="https://unpkg.com/[email protected]/dist/vue-form-json-schema.umd.js"></script>
You can substite [email protected] to a fixed version, such as [email protected]
Installed from npm
<script src="../node_modules/dist/vue-form-json-schema.umd.js"></script>
Demo
Note that all demos use Bootstrap styling, but no styling is included in this package and it is up to you what styles should be used.
​Minimal demo​
The least amount of configuration to render an input element.
​Nested UI demo​
Using Bootstrap classes to show how layout can be different for devices with different screen sizes. In this example two input fields will be wrapped inside a div with col-12 col-sm-6 classes. Try resizing your browser window too see it in action.
​Conditional visibility and Animation demo​
Sometimes a field should only be shown if a condition is met. Uses <transition> to provide animation.
​Vue components demo​
See how to use your own or third party Vue components in vue-form-json-schema.
​Vue async loading of form​
Loading the form from a backend? Check out this example.
​Registration form with validation​
A more complete example with validation and error messages
UMD demos
All the examples above are replicated using the UMD version in the examples folder of this repo.
​Online version of the first demo​
Features
Supports any HTML element or Vue component
Small (32K uncompressed, 6.5K gzipped)
Standardized JSON schema for annotation and validation (by Ajv)
Layout is independent from data structure
Documentation
​Gitbook​
Usage
Basic example with one field
For using the UMD version, check out the examples folder where all the demos above are replicated using the UMD version
​See demo​
1
<template>
2
    <vue-form-json-schema
3
      v-model="model"
4
      :schema="schema"
5
      :ui-schema="uiSchema"
6
    >
7
  </vue-form-json-schema>
8
</template>
9
​
10
<script>
11
  export default {
12
    data() {
13
      return {
14
        // An object which holds the form values
15
        model: {},
16
        // A valid JSON Schema object
17
        schema: {
18
          type: 'object',
19
          properties: {
20
            firstName: {
21
              type: 'string',
22
            },
23
          },
24
        },
25
        // Array of HTML elements or Vue components
26
        uiSchema: [{
27
          component: 'input',
28
          model: 'firstName',
29
          // Same API as [Vue's render functions](https://vuejs.org/v2/guide/render-function.html#The-Data-Object-In-Depth)
30
          fieldOptions: {
31
            class: ['form-control'],
32
            on: ['input'],
33
            attrs: {
34
              placeholder: 'Please enter your first name',
35
            },
36
          },
37
        }],
38
      };
39
    }
40
  };
41
</script>
Copied!
Dependencies
Ajv
For form validation using JSON Schema and internal validation
Lodash
get, set and merge are used throughout the package. Bundle size is very important though and is always considered and so we heavily strip down lodash to only include the absolute necessities
Vue
Tested with v2.5.9 but will probably work on any version >= v2.4.0
TODO
Write tests
Add i18n support
Added in 1.15.2 with options.ajv.locale setting
Write this README
Use Ajv internally to validate:
vfs-global prop ui-schema
vfs-component prop ui-schema
Write docs
Publish with Gitbook