mirror of https://github.com/Tencent/tmagic-editor.git synced 2026-05-20 07:23:38 +00:00

roymondchen 873a51fc87 docs: 升级 VitePress 至 v2 alpha，类型引用改为源码片段同步

- 升级 vitepress 到 ^2.0.0-alpha.17
- vite.optimizeDeps.rolldownOptions.transform.define 迁移至 vite.define 以适配 v2 API
- 同步升级 vitest/rolldown/vue/vite 等周边依赖
- 文档中类型链接统一改为 <<< 片段引用源码 region，避免 commit hash 链接失效
- packages/{core,editor,form-schema,schema,stage} 相关类型加 // #region 锚点
- 移除已废弃的 docs/guide/advanced/tmagic-ui.md 及侧栏入口

Co-authored-by: Cursor <cursoragent@cursor.com>

2026-05-18 11:47:03 +08:00

3.8 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`	—	-

::: 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 查看 DataSourceFieldSelectConfig 配置类型定义 <<< @/../packages/form-schema/src/editor.ts#DataSourceFieldSelectConfig{ts}

<<< @/../packages/form-schema/src/base.ts#FormItem{ts}

:::

value说明

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

3.8 KiB Raw Blame History Unescape Escape