mirror of
https://github.com/Tencent/tmagic-editor.git
synced 2026-08-09 06:18:33 +00:00
1c67b5e77b
- 新增 typeMatchRules.ts，为编辑器自定义字段注册内置 typeMatch 校验规则 - 抽取 event.ts 事件工具函数 - form typeMatch 适配 TDesign 校验器签名，错误消息补充实际值 - rules.md 新增「Editor 字段内置规则」章节，16 个字段文档补充校验说明
67 lines
2.6 KiB
Markdown
67 lines
2.6 KiB
Markdown
# KeyValue 键值对
|
|
|
|
用于配置键值对数据的表单组件。
|
|
|
|
::: warning 注意
|
|
此组件仅在编辑器环境中可用，需要配合 `@tmagic/editor` 使用。
|
|
:::
|
|
|
|
## 基础用法
|
|
|
|
```js
|
|
{
|
|
type: 'key-value',
|
|
name: 'params',
|
|
text: '参数'
|
|
}
|
|
```
|
|
|
|
## 高级模式
|
|
|
|
设置 `advanced` 为 `true`，可切换到代码编辑模式。
|
|
|
|
```js
|
|
{
|
|
type: 'key-value',
|
|
name: 'params',
|
|
text: '参数',
|
|
advanced: true
|
|
}
|
|
```
|
|
|
|
## 值校验
|
|
|
|
安装 `@tmagic/editor` 后该字段会自动注册内置 `typeMatch` 校验规则：须为普通对象，`advanced` 且值为 `function` 时放行。详见[表单校验 - Editor 字段内置规则](/form-config/rules.md#editor-字段内置规则)。
|
|
|
|
## Attributes
|
|
|
|
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|
|
| -------- | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------ |
|
|
| name | 绑定值 | string | — | — |
|
|
| text | 表单标签 | string | — | — |
|
|
| disabled | 是否禁用 | boolean / `FilterFunction` | — | false |
|
|
| advanced | 是否支持高级模式（代码编辑） | boolean | — | false |
|
|
| 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 查看 KeyValueConfig 配置类型定义
|
|
<<< @/../packages/form-schema/src/editor.ts#KeyValueConfig{ts}
|
|
|
|
<<< @/../packages/form-schema/src/base.ts#FormItem{ts}
|
|
|
|
:::
|