跳到主要内容

unitedSchema JSON配置

unitedSchema.json是配置Drip-form的JSON配置文件，主要包括数据和UI两个维度的配置，下面将详细介绍这个核心文件的配置项。

参数​

unitedSchema是一个json对象，它的基础结构应该包括以下几个部分。

unitedSchema.json
{
  "validateTime" : "submit",
  "type": "object",
    "theme": "drip-theme",
    "schema": [ Schema, ... ]
}
属性说明类型必填默认值
validateTime校验时机。 submit、changeStringyessubmit
type验证关键字。 null、boolean、object、array、number、nullString、Arrayyesobject
theme使用的默认主题类型。stringyesant-design
schemaui和校验配置联合配置。 SchemaArrayyes

Schema的结构​

schema是一个数组，最后表单会按照数组的顺序进行排序，里面的每个元素都是对象形式，其结构如下所示：

schema
[
    {
        "fieldKey": "selectText",
        "type": "object",
        "title": "测试联合schema",
        "ui": {
            "type": "selectText",
            "placeholder": "请选择",
            "allowClear": true,
            "multiple": true,
            "requestCache": true,
            "options": [
                { "label": "北京", "value": "0" },
                { "label": "上海", "value": "1" },
                { "label": "成都", "value": "2" },
                { "label": "武汉", "value": "3" }
            ]
        }
    },
  {
    "title": "名字",
    "type": "string",
    "fieldKey": "name",
    "ui": {
      "type": "text",
      "placeholder": "请输入name，当name1有值时，该表单隐藏",
      "description": {
        "type": "icon",
        "title": "hover触发提示",
        "trigger": "hover"
      }
    }
  }
]

Schema的参数​

属性说明类型必填
fieldKey表单数据存放字段（必须唯一）stringyes
type表单数据类型stringyes
title表单标题stringno
requiredMsg表单必填的错误信息（存在这个字段则并且不为空字符表示当前表单必填）stringno
errMsg表单校验错误信息stringno
ui表单ui控件的propsObjectno
$:xxx用户自定义数据，drip-form不做任何处理anyno
其它字段自定义校验关键字、ajv-keywords关键字、jsonSchema校验关键字等anyno