mirror of
https://github.com/Tencent/tmagic-editor.git
synced 2026-08-09 22:38:34 +00:00
1c67b5e77b
- 新增 typeMatchRules.ts，为编辑器自定义字段注册内置 typeMatch 校验规则 - 抽取 event.ts 事件工具函数 - form typeMatch 适配 TDesign 校验器签名，错误消息补充实际值 - rules.md 新增「Editor 字段内置规则」章节，16 个字段文档补充校验说明
66 lines
2.7 KiB
Markdown
66 lines
2.7 KiB
Markdown
# DisplayConds 显示条件配置
|
|
|
|
用于配置组件显示条件的表单组件。
|
|
|
|
::: warning 注意
|
|
此组件仅在编辑器环境中可用，需要配合 `@tmagic/editor` 使用。
|
|
:::
|
|
|
|
## 基础用法
|
|
|
|
```js
|
|
{
|
|
type: 'display-conds',
|
|
name: 'displayConds',
|
|
text: '显示条件'
|
|
}
|
|
```
|
|
|
|
## 带标题前缀
|
|
|
|
```js
|
|
{
|
|
type: 'display-conds',
|
|
name: 'displayConds',
|
|
text: '显示条件',
|
|
titlePrefix: '条件'
|
|
}
|
|
```
|
|
|
|
## 值校验
|
|
|
|
安装 `@tmagic/editor` 后该字段会自动注册内置 `typeMatch` 校验规则：须为数组并做 `cond[].field`/`op` 浅层结构校验，算子合法性 / 字段路径存在性由内部单元格各自校验。服务数据未就绪时仅做基础形态校验。详见[表单校验 - Editor 字段内置规则](/form-config/rules.md#editor-字段内置规则)。
|
|
|
|
## Attributes
|
|
|
|
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|
|
| ------------ | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------ |
|
|
| name | 绑定值 | string | — | — |
|
|
| text | 表单标签 | string | — | — |
|
|
| disabled | 是否禁用 | boolean / `FilterFunction` | — | false |
|
|
| titlePrefix | 标题前缀 | string | — | — |
|
|
| parentFields | 父级字段 | string[] / `FilterFunction` | — | — |
|
|
| onChange | 值变化时触发的函数 | `OnChangeHandler` | — | - |
|
|
|
|
::: details 查看 FilterFunction / OnChangeHandler 及关联类型定义
|
|
<<< @/../packages/form-schema/src/base.ts#FilterFunction{ts}
|
|
|
|
<<< @/../packages/form-schema/src/base.ts#OnChangeHandler{ts}
|
|
|
|
<<< @/../packages/form-schema/src/base.ts#OnChangeHandlerData{ts}
|
|
|
|
<<< @/../packages/form-schema/src/base.ts#ChangeRecord{ts}
|
|
|
|
<<< @/../packages/form-schema/src/base.ts#FormValue{ts}
|
|
:::
|
|
|
|
|
|
## 配置类型
|
|
|
|
::: details 查看 DisplayCondsConfig 配置类型定义
|
|
<<< @/../packages/form-schema/src/editor.ts#DisplayCondsConfig{ts}
|
|
|
|
<<< @/../packages/form-schema/src/base.ts#FormItem{ts}
|
|
|
|
:::
|