mirror of
https://github.com/Tencent/tmagic-editor.git
synced 2026-05-09 01:58:48 +00:00
补全方法的参数类型、返回值类型与详情说明,规范字段编辑器/字段配置/运行时 API 等文档。 Co-authored-by: Cursor <cursoragent@cursor.com>
58 lines
3.1 KiB
Markdown
58 lines
3.1 KiB
Markdown
# DataSourceSelect 数据源选择器
|
||
|
||
用于选择数据源的下拉选择器。
|
||
|
||
::: warning 注意
|
||
此组件仅在编辑器环境中可用,需要配合 `@tmagic/editor` 使用。
|
||
:::
|
||
|
||
## 基础用法
|
||
|
||
```js
|
||
{
|
||
type: 'data-source-select',
|
||
name: 'dataSource',
|
||
text: '数据源'
|
||
}
|
||
```
|
||
|
||
## 过滤数据源类型
|
||
|
||
```js
|
||
{
|
||
type: 'data-source-select',
|
||
name: 'dataSource',
|
||
text: '数据源',
|
||
dataSourceType: 'http'
|
||
}
|
||
```
|
||
|
||
## 返回数据源ID
|
||
|
||
```js
|
||
{
|
||
type: 'data-source-select',
|
||
name: 'dataSource',
|
||
text: '数据源',
|
||
value: 'id'
|
||
}
|
||
```
|
||
|
||
## Attributes
|
||
|
||
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|
||
| -------------- | ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ------ |
|
||
| name | 绑定值 | string | — | — |
|
||
| text | 表单标签 | string | — | — |
|
||
| placeholder | 输入框占位文本 | string | — | — |
|
||
| disabled | 是否禁用 | boolean / [FilterFunction](https://github.com/Tencent/tmagic-editor/blob/cce8b63fc3618b5b811aa33c703de21c22be8a6a/packages/form-schema/src/base.ts#L195) | — | false |
|
||
| dataSourceType | 数据源类型过滤 | string | base/http等 | — |
|
||
| value | 返回值类型 | string | id/value | — |
|
||
| notEditable | 是否不可编辑数据源(disable控制是否可选择) | boolean / [FilterFunction](https://github.com/Tencent/tmagic-editor/blob/cce8b63fc3618b5b811aa33c703de21c22be8a6a/packages/form-schema/src/base.ts#L195) | — | false |
|
||
| onChange | 值变化时触发的函数 | [OnChangeHandler](https://github.com/Tencent/tmagic-editor/blob/cce8b63fc3618b5b811aa33c703de21c22be8a6a/packages/form-schema/src/base.ts#L30) | — | - |
|
||
|
||
## value说明
|
||
|
||
- `id`: 不编译,返回数据源id
|
||
- `value`: 编译后返回数据源data
|