Vue JSON Schema Form 项目教程

2024-08-08 17:39:56作者：丁柯新Fawn

基于Vue/Vue3，Json Schema 和 ElementUi/antd/iview3/naiveUi 等生成 HTML Form 表单，用于活动编辑器、h5编辑器、cms等数据配置；支持可视化生成表单Schema 。 Generate a form using Vue/Vue3, Json Schema and ElementUi/antdv/iview3/naiveUi

项目地址：https://gitcode.com/gh_mirrors/vu/vue-json-schema-form

1. 项目的目录结构及介绍

vue-json-schema-form/
├── dist/
│   ├── vueJsonSchemaForm.umd.min.js
│   └── ...
├── src/
│   ├── components/
│   │   ├── VueForm.vue
│   │   └── ...
│   ├── utils/
│   │   ├── schemaValidate.js
│   │   └── ...
│   ├── index.js
│   └── ...
├── package.json
├── README.md
└── ...

dist/: 打包后的文件，包含UMD格式的JavaScript文件。
src/: 源代码目录。
- components/: Vue组件，核心组件为VueForm.vue。
- utils/: 工具函数，如schemaValidate.js用于Schema校验。
- index.js: 入口文件。
package.json: 项目的配置文件，包含依赖、脚本等信息。
README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件为src/index.js，该文件主要负责导出Vue组件和工具函数，供外部使用。

import VueForm from './components/VueForm.vue';
import { getDefaultFormState, fieldProps, vueUtils, formUtils, schemaValidate, i18n } from './utils';

export {
    VueForm,
    getDefaultFormState,
    fieldProps,
    vueUtils,
    formUtils,
    schemaValidate,
    i18n
};

3. 项目的配置文件介绍

项目的配置文件为package.json，该文件包含了项目的元数据、依赖、脚本等信息。

{
  "name": "@lljj/vue-json-schema-form",
  "version": "1.0.0",
  "description": "基于Vue/Vue3 Json Schema 和 ElementUi/antd/iview3/naiveUi 等生成 HTML Form 表单",
  "main": "dist/vueJsonSchemaForm.umd.min.js",
  "scripts": {
    "build": "rollup -c",
    "dev": "rollup -c -w",
    "test": "jest"
  },
  "dependencies": {
    "vue": "^2.6.12",
    "ajv": "^6.12.6"
  },
  "devDependencies": {
    "rollup": "^2.3.4",
    "jest": "^26.6.3"
  },
  "author": "lljj-x",
  "license": "Apache-2.0"
}

name: 项目名称。
version: 项目版本。
description: 项目描述。
main: 入口文件。
scripts: 脚本命令，如build用于打包，dev用于开发，test用于测试。
dependencies: 生产环境依赖。
devDependencies: 开发环境依赖。
author: 作者。
license: 许可证。