> For the complete documentation index, see [llms.txt](https://vue-generators.gitbook.io/vue-generators/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://vue-generators.gitbook.io/vue-generators/develop/installation.md).

# Installation

## NPM

You can install it via [NPM](http://npmjs.org/).

```
$ 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

```javascript
<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. &#x20;
* 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:

```javascript
// "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](https://github.com/taylorhakes/fecha) and [lodash](https://lodash.com/) 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](https://github.com/vue-generators/vue-form-generator-docs/tree/694e437ea177a15e3110c0c2fe507ace8485a23d/googleaddress.md)   |
| Color picker         | [spectrum](https://github.com/vue-generators/vue-form-generator-docs/tree/694e437ea177a15e3110c0c2fe507ace8485a23d/spectrum.md) | N/A                                                                                                                                         |
| Date picker          | [datetime](https://github.com/vue-generators/vue-form-generator-docs/tree/694e437ea177a15e3110c0c2fe507ace8485a23d/datetime.md) | [pikaday](https://github.com/vue-generators/vue-form-generator-docs/tree/694e437ea177a15e3110c0c2fe507ace8485a23d/pikaday.md)               |
| Masked Input         | [masked](https://github.com/vue-generators/vue-form-generator-docs/tree/694e437ea177a15e3110c0c2fe507ace8485a23d/masked.md)     | [cleave](https://github.com/vue-generators/vue-form-generator-docs/tree/694e437ea177a15e3110c0c2fe507ace8485a23d/cleave.md)                 |
| Multi Selection      | [selectEx](https://github.com/vue-generators/vue-form-generator-docs/tree/694e437ea177a15e3110c0c2fe507ace8485a23d/selectex.md) | [vueMultiSelect](https://github.com/vue-generators/vue-form-generator-docs/tree/694e437ea177a15e3110c0c2fe507ace8485a23d/vuemultiselect.md) |
| Slider               | [slider](https://github.com/vue-generators/vue-form-generator-docs/tree/694e437ea177a15e3110c0c2fe507ace8485a23d/slider.md)     | [noUiSlider](https://github.com/vue-generators/vue-form-generator-docs/tree/694e437ea177a15e3110c0c2fe507ace8485a23d/nouislider.md)         |

You can find details about dependencies in each field page.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://vue-generators.gitbook.io/vue-generators/develop/installation.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.