mirror of
https://github.com/zhigang1992/form-render.git
synced 2026-01-12 22:47:30 +08:00
3.0 KiB
3.0 KiB
如何联动
表单组件间的联动是开发中普遍的问题,form-render 希望能保持简洁易用的 api 的同时支持联动。我们认为最直接和易用的方案就是支持函数表达式
属性支持函数表达式
当使用 js 对象作为 schema 时,属性的值可以传函数,这加大了开发的自由度。schema 里大部分的属性都支持使用函数表达式,
- 支持的属性中比较常用的是,
ui:options,ui:disabled,ui:hidden和enum。当然 2 中没有提及的属性都支持。 - 注意,部分属性不支持函数表达式,主要原因是这些属性关系到表单的值的初始化(所以如果再对表单的值依赖会有问题)。这些属性是
type,items,properties,required,default和ui:widget。幸运的是这些属性本来也很少会有联动的需求。请勿赋值这些字段函数表达式,否则轻则报错,重则静默出错。 - 函数表达式接收一下三个参数:
| 名称 | 说明 |
|---|---|
| formData | 整个 form 的值 (最常用,当两个关联组件距离较远时,可以从顶层的 formData 里获取) |
| rootValue | 父组件的值 (比较常用,上一级的值,方便从中能获取所有兄弟组件的值) |
使用方式如下
{
propsSchema: {
type: "object",
properties: {
select: {
title: "单选",
type: "string",
enum: () => ["a", "b", "c"],
"ui:disabled": (formData, rootValue) => rootValue.input1.length > 5
},
input1: {
title: "输入框",
type: "string",
"ui:hidden": (formData, rootValue) => formData.select === "b"
}
}
}
}
如果 schema 需要通过服务端传递,不得不使用 JSON 形式呢?这样就无法使用函数解析式作为属性的值了,此时,form-render 提供了以{{}}包含的字段表达函数:
{
propsSchema: {
type: "object",
properties: {
select: {
title: "单选",
type: "string",
enum: () => ["a", "b", "c"],
"ui:disabled": "{{rootValue.input1.length > 5}}"
},
input1: {
title: "输入框",
type: "string",
"ui:hidden": "{{formData.select === 'b'}}"
}
}
}
}
form-render 以{{}}作为提示符,将其包含的字符串作为函数解析并返回运算结果。与函数相同,这段字符串可调用 formData 和 rootValue 两个参数。
注:在上一个版本我们使用@作为函数表达式的提示符,现在仍然兼容,但往后推荐用{{}}。主要原因是 1. {{}}作为表达式提示符在广大模板引擎里已经是默认,2. @可能真实会被用于字符串输入内容,产生误解析。
更复杂和定制化的表单需求建议使用自定义组件。form-render 的设计理念非常推崇组件的即插即用,详见自定义组件章节。