Skip to content
On this page

⚡️ 跟Vue 3项目集成

0. 简介

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

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

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

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

1. 安装

bash
npm i vform3-mobile-builds
bash
yarn add vform3-mobile-builds

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

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

import Vant from 'vant';	//引入vant库
import ElementPlus from 'element-plus'  //引入element-plus库
import VmForm3 from 'vform3-mobile-builds'  //引入VmForm库

import 'vant/lib/index.css';	//引入vant样式
import 'element-plus/dist/index.css';
import 'vform3-mobile-builds/dist/VmFormDesigner.css'  //引入VmForm样式

const app = createApp(App)

app.use(ElementPlus)  //全局注册element-plus
app.use(Vant);  //全局注册vant
app.use(VmForm3)  //全局注册VForm(同时注册了vm-form-designer和vm-form-render组件)

/* 注意:如果你的项目中有使用axios,请用下面一行代码将全局axios复位为你的axios!! */
window.axios = axios

app.mount('#app')

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

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

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

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

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

html
<template>
  <div>
    <vm-form-render :form-json="formJson" :form-data="formData" :option-data="optionData" ref="vFormRef">
    </vm-form-render>
    <el-button type="primary" @click="submitForm">Submit</el-button>
  </div>
</template>
<script>
  export default {
    data() {
      return {
        formJson: {"widgetList":[],"formConfig":{"labelWidth":80,"labelPosition":"left","size":"","labelAlign":"label-left-align","cssCode":"",
        "customClass":"","functions":"","layoutType":"H5","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官方