tmagic-editor/docs/form-config/editor-fields/data-source-field-select.md
roymondchen 3eb8cc0614 docs: 完善 editor/form/runtime/stage 等 API 文档参数与说明
补全方法的参数类型、返回值类型与详情说明,规范字段编辑器/字段配置/运行时 API 等文档。

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-05-07 17:33:58 +08:00

3.6 KiB
Raw Blame History

DataSourceFieldSelect 数据源字段选择器

用于选择数据源字段的级联选择器。

::: warning 注意 此组件仅在编辑器环境中可用,需要配合 @tmagic/editor 使用。 :::

基础用法

{
  type: 'data-source-field-select',
  name: 'field',
  text: '数据源字段'
}

返回字段key

{
  type: 'data-source-field-select',
  name: 'field',
  text: '数据源字段',
  value: 'key'
}

限制字段类型

{
  type: 'data-source-field-select',
  name: 'field',
  text: '数据源字段',
  dataSourceFieldType: ['string', 'number']
}

父子节点不关联

{
  type: 'data-source-field-select',
  name: 'field',
  text: '数据源字段',
  checkStrictly: true
}

Attributes

参数 说明 类型 可选值 默认值
name 绑定值 string
text 表单标签 string
disabled 是否禁用 boolean / FilterFunction false
value 返回值类型 string key/value
checkStrictly 是否严格遵守父子节点不互相关联 boolean / Function
dataSourceFieldType 允许选择的字段类型 DataSourceFieldType[]
fieldConfig 自定义字段配置 ChildConfig
notEditable 是否不可编辑数据源disable控制是否可选择 boolean / FilterFunction false
onChange 值变化时触发的函数 OnChangeHandler -

value说明

  • key: 不编译返回数据源id和字段name
  • value: 编译后返回数据源data[field]