mirror of https://github.com/Tencent/tmagic-editor.git synced 2026-05-08 17:48:47 +00:00

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

Radio 单选框

在一组备选项中进行单选

TS 定义

interface RadioGroup extends FormItem {
  type: "radio-group";
  childType?: "default" | "button";
  options: {
    value: any;
    text?: string;
    icon?: any;
    tooltip?: string;
  }[];
}

点击查看FormItem的定义

基础用法

由于选项默认可见，不宜过多，若选项过多，建议使用 Select 选择器。

要使用 Radio 组件，只需要配置type: 'radio-group'。

禁用状态

单选框不可用的状态。

只要在配置中设置 disabled 属性即可，它接受一个 Boolean ， true 为禁用，也可以接受一个返回 Boolean 的函数。

RadioGroup Attributes

参数	说明	类型	可选值	默认值
name	绑定值	string	—	—
text	表单标签	string	—	—
disabled	是否禁用	boolean / FilterFunction	—	false
childType	子项展示形式	string	default / button	default
options	选项	Array	—	-
onChange	值变化时触发的函数	OnChangeHandler	—	-

options item

参数	说明	类型	可选值	默认值
value	选项的值	string / number / boolean	—	—
text	选项的标签	string	—	—
icon	选项的图标组件	any	—	—
tooltip	鼠标悬停时显示的提示内容	string	—	—

3.6 KiB Raw Blame History Unescape Escape