Skip to content

Latest commit

 

History

History
68 lines (49 loc) · 2.04 KB

installation.md

File metadata and controls

68 lines (49 loc) · 2.04 KB

Installation

NPM

You can install it via NPM.

$ npm install --save vue-form-generator

Manual

Download zip package, unpack and add the vfg.css and vfg.js file to your project from /dist folder.

https://github.com/vue-generators/vue-form-generator/releases/latest

Import into Project

<script>
    import Vue from 'vue';
    import VueFormGenerator from 'vue-form-generator'
    import 'vue-form-generator/dist/vfg.css'
    Vue.use(VueFormGenerator)
</script>

Core vs Full version

VueFormGenerator can be setup using the 'core' or 'full' variations.

  • Core is a minimal version with only half the fields.
  • Full is core + other fields.

If you don't know what to choose, don't worry, full is the default version. If you want the slimmed down version, here are the changes:

// "core" only
<script>
    import Vue from 'vue'
    import VueFormGenerator from 'vue-form-generator/dist/vfg-core.js'
    import 'vue-form-generator/dist/vfg-core.css'
    Vue.use(VueFormGenerator)
</script>

Dependencies

VueFormGenerator uses fecha and lodash internally.

While core fields don't require external dependencies, optional fields in the full package may need additional libraries.
These dependencies fall into two camps: jQuery or Vanilla. You can find almost the same functionality in both flavors. That way, it's your choice to depend on jQuery or not.

Field type jQuery Vanilla
Address autocomplete N/A googleAddress
Color picker spectrum N/A
Date picker datetime pikaday
Masked Input masked cleave
Multi Selection selectEx vueMultiSelect
Slider slider noUiSlider

You can find details about dependencies in each field page.