README.md

FFV

Form For Vue

Generate form based on standard json-schema and customize it using ui-schema

Installation

npm install --save ffv

Usage

Bundler (Webpack, Rollup)

import Vue from 'vue'
import Ffv from 'ffv'

Vue.use(Ffv)

Browser

<!-- Include after Vue -->
<!-- Local files -->
<link rel="stylesheet" href="ffv/dist/ffv.css"></link>
<script src="ffv/dist/ffv.js"></script>

<!-- From CDN -->
<link rel="stylesheet" href="https://unpkg.com/ffv/dist/ffv.css"></link>
<script src="https://unpkg.com/ffv"></script>

Form initialization

<template>
  <v-form
    :schema="schema"
    v-model="value">
  </v-form>
</template>

<script>
export default {
  data() {
    return {
      schema: {
        "type": "object",
        "title": "Basic Form",
        "required": [
          "firstName",
          "lastName",
        ],
        "properties": {
          "firstName": {
            "type": "string",
            "title": "First name"
          },
          "lastName": {
            "type": "string",
            "title": "Last name"
          }
        }
      },
      value: null,
    }
  }
}
</script>

UiSchema

uiSchema for jsonSchema is just like what css is for HTML. We use it to instruct ffv how we want our form to be seen. To customize each prop pass available options for that widget in ui:options of that prop.

const schema = {
  type: "object",
  properties: {
    firstName: {
      type: "string",
    },
    lastName: {
      type: "string",
    }
  }
}
const uiSchema = {
  firstName: {
    "ui:options": {
      ...
    }
  },
  lastName: {
    "ui:options": {
      ...
    }
  }
}

Widgets

ffv has a very flexible approach in using widgets and props, in fact it simply add form functionality such as validation to components of your own or built-in ffv components. you can pass your own widgets or props based on ffv template or use built-in widgets and props. built-in components are listed below

widget options

• checkbox
• file
• input
• radio
• select
• text-area

Development

Build

Bundle the js and css of to the dist folder:

npm run build

Publishing

The prepublish hook will ensure dist files are created before publishing. This way you don't need to commit them in your repository.

# Bump the version first
# It'll also commit it and create a tag
npm version
# Push the bumped package and tags
git push --follow-tags
# Ship it 🚀
npm publish

License

MIT