Skip to content
On this page

npmnpm

📓 简介

VForm 2是一款基于Vue 2的低代码表单,支持Element UI组件库,定位为前端开发人员提供快速搭建表单、实现表单交互和数据收集的功能。

VForm全称为Variant Form,寓意为灵活的、动态的、多样化的Vue低代码表单。

VForm由表单设计器VFormDesigner和表单渲染器VFormRender两部分构成,VFormDesigner通过拖拽组件方式生成JSON格式的表单对象,VFormRender负责将表单JSON渲染为Vue组件。

VForm提供了丰富的组件属性设置、表单交互事件和API方法,并且为开发者预留了拓展组件库的二次开发接口。

📺 视频教程


🏷️ 在线示例

👉 子表单演示(限Pro版)
子表单小计和累计自动更新

⚡️ 跟Vue 2项目集成

1. 安装

bash
npm i vform-builds
bash
yarn add vform-builds

2. 引入并全局注册VForm组件

js
import Vue from 'vue'
import App from './App.vue'
import axios from 'axios'  //如果需要axios,请引入

import ElementUI from 'element-ui'  //引入element-ui库
import VForm from 'vform-builds'  //引入VForm库

import 'element-ui/lib/theme-chalk/index.css'  //引入element-ui样式
import 'vform-builds/dist/VFormDesigner.css'  //引入VForm样式

Vue.config.productionTip = false

Vue.use(ElementUI)  //全局注册element-ui
Vue.use(VForm)  //全局注册VForm(同时注册了v-form-designer和v-form-render组件)
/* 注意:如果你的项目中有使用axios,请用下面一行代码将全局axios复位为你的axios!! */
window.axios = axios

new Vue({
  render: h => h(App),
}).$mount('#app')

3. 在Vue 2模板中使用表单设计器组件

html
<template>
  <v-form-designer></v-form-designer>
</template>

<script>
  export default {
    data() {
      return {
      }
    }
  }
</script>

<style lang="scss">
body {
  margin: 0;  /* 如果页面出现垂直滚动条,则加入此行CSS以消除之 */
}
</style>

4. 在Vue 2模板中使用表单渲染器组件

html
<template>
  <div>
    <v-form-render :form-json="formJson" :form-data="formData" :option-data="optionData" ref="vFormRef">
    </v-form-render>
    <el-button type="primary" @click="submitForm">Submit</el-button>
  </div>
</template>
<script>
  export default {
    data() {
      return {
        /* 注意:formJson是指表单设计器导出的json,此处演示的formJson只是一个空白表单json!! */
        formJson: {"widgetList":[],"formConfig":{"labelWidth":80,"labelPosition":"left","size":"",
        "labelAlign":"label-left-align","cssCode":"","customClass":"","functions":"","layoutType":"PC",
        "onFormCreated":"","onFormMounted":"","onFormDataChange":""}},
        formData: {},
        optionData: {}
      }
    },
    methods: {
      submitForm() {
        this.$refs.vFormRef.getFormData().then(formData => {
          // Form Validation OK
          alert( JSON.stringify(formData) )
        }).catch(error => {
          // Form Validation failed
          this.$message.error(error)
        })
      }
    }
  }
</script>

Variant Form官方