import{ax as t,al as l,z as p,A as e,B as i,R as h,b5 as d,O as a,J as k}from"./chunks/framework.DRScawWW.js";const B=JSON.parse('{"title":"Radio 单选框","description":"","frontmatter":{},"headers":[],"relativePath":"form-config/fields/radio.md","filePath":"form-config/fields/radio.md"}'),r={name:"form-config/fields/radio.md"};function g(F,s,y,E,o,A){const n=l("demo-block");return e(),p("div",null,[s[2]||(s[2]=i("h1",{id:"radio-单选框",tabindex:"-1"},[a("Radio 单选框 "),i("a",{class:"header-anchor",href:"#radio-单选框","aria-label":"Permalink to “Radio 单选框”"},"​")],-1)),s[3]||(s[3]=i("p",null,"在一组备选项中进行单选",-1)),s[4]||(s[4]=i("h2",{id:"基础用法",tabindex:"-1"},[a("基础用法 "),i("a",{class:"header-anchor",href:"#基础用法","aria-label":"Permalink to “基础用法”"},"​")],-1)),s[5]||(s[5]=i("p",null,"由于选项默认可见，不宜过多，若选项过多，建议使用 Select 选择器。",-1)),h(n,{type:"form",config:[{type:"radio-group",name:"radio",text:"选项",options:[{text:"选项1",value:1},{text:"选项2",value:2}]}]},{source:k(()=>[...s[0]||(s[0]=[i("p",null," 要使用 Radio 组件，只需要配置type: 'radio-group'。 ",-1)])]),_:1}),s[6]||(s[6]=i("h2",{id:"禁用状态",tabindex:"-1"},[a("禁用状态 "),i("a",{class:"header-anchor",href:"#禁用状态","aria-label":"Permalink to “禁用状态”"},"​")],-1)),s[7]||(s[7]=i("p",null,"单选框不可用的状态。",-1)),h(n,{type:"form",config:[{type:"radio-group",name:"radio",text:"选项",options:[{text:"选项1",value:1},{text:"选项2",value:2}],disabled:()=>!0}]},{source:k(()=>[...s[1]||(s[1]=[i("p",null," 只要在配置中设置 disabled 属性即可，它接受一个 Boolean ， true 为禁用，也可以接受一个返回 Boolean 的函数。 ",-1)])]),_:1}),s[8]||(s[8]=d(`

RadioGroup Attributes ​

参数说明类型可选值默认值
name绑定值string——
text表单标签string——
disabled是否禁用boolean / FilterFunction—false
childType子项展示形式stringdefault / buttondefault
options选项Array—-
onChange值变化时触发的函数OnChangeHandler—-
查看 FormItem / FilterFunction / OnChangeHandler 及关联类型定义
ts
export interface FormItem {
  /** vnode的key值，默认是遍历数组时的index */
  __key?: string | number;
  /** 表单域标签的的宽度，例如 '50px'。支持 auto。 */
  labelWidth?: string | number;
  /** label 标签的title属性 */
  labelTitle?: string;
  className?: string;
  /** 字段名 */
  name?: string | number;
  /** 额外的提示信息，和 help 类似，当提示文案同时出现时，可以使用这个。 */
  extra?: string | FilterFunction<string>;
  /** 配置提示信息 */
  tooltip?: ToolTipConfigType | FilterFunction<ToolTipConfigType>;
  /** 是否置灰 */
  disabled?: boolean | FilterFunction;
  /** 使用表单中的值作为key，例如配置了text，则使用model.text作为key */
  key?: string;
  /** 是否显示 */
  display?: boolean | 'expand' | FilterFunction<boolean | 'expand'>;
  /** 值发生改变时调用的方法 */
  onChange?: OnChangeHandler;
  /** label 标签的文本 */
  text?: string | FilterFunction<string>;
  /** 右侧感叹号 */
  tip?: string;

  filter?: 'number' | OnChangeHandler;
  /** 是否去除首尾空格 */
  trim?: boolean;
  /** 默认值 */
  defaultValue?: any | DefaultValueFunction;
  /** 表单验证规则 */
  rules?: Rule[];
  extensible?: boolean;
  dynamicKey?: string;
  /** 是否需要显示\`展开更多配置\` */
  expand?: boolean;
  style?: Record<string, any>;
  fieldStyle?: Record<string, any>;
  labelPosition?: 'top' | 'left' | 'right';
}
ts
export type FilterFunction<T = boolean> = (
  mForm: FormState | undefined,
  data: {
    model: FormValue;
    values: FormValue;
    parent?: FormValue;
    formValue: FormValue;
    prop: string;
    config: any;
    index?: number;
    getFormValue: (prop: string) => any;
  },
) => T;
ts
export type OnChangeHandler = (mForm: FormState | undefined, value: any, data: OnChangeHandlerData) => any;
ts
export interface OnChangeHandlerData {
  model: FormValue;
  values?: Readonly<FormValue> | null;
  parent?: FormValue;
  formValue?: FormValue;
  config: Readonly<any>;
  prop: string;
  changeRecords: ChangeRecord[];
  setModel: (prop: string, value: any) => void;
  setFormValue: (prop: string, value: any) => void;
}
ts
export interface ChangeRecord {
  propPath?: string;
  value: any;
}
ts
export type FormValue = Record<string | number, any>;

配置类型 ​

查看 RadioGroupConfig 配置类型定义
ts
export interface RadioGroupConfig extends FormItem {
  type: 'radio-group' | 'radioGroup';
  childType?: 'default' | 'button';
  options: {
    value: string | number | boolean;
    text?: string;
    icon?: any;
    tooltip?: string;
  }[];
}
ts
export interface FormItem {
  /** vnode的key值，默认是遍历数组时的index */
  __key?: string | number;
  /** 表单域标签的的宽度，例如 '50px'。支持 auto。 */
  labelWidth?: string | number;
  /** label 标签的title属性 */
  labelTitle?: string;
  className?: string;
  /** 字段名 */
  name?: string | number;
  /** 额外的提示信息，和 help 类似，当提示文案同时出现时，可以使用这个。 */
  extra?: string | FilterFunction<string>;
  /** 配置提示信息 */
  tooltip?: ToolTipConfigType | FilterFunction<ToolTipConfigType>;
  /** 是否置灰 */
  disabled?: boolean | FilterFunction;
  /** 使用表单中的值作为key，例如配置了text，则使用model.text作为key */
  key?: string;
  /** 是否显示 */
  display?: boolean | 'expand' | FilterFunction<boolean | 'expand'>;
  /** 值发生改变时调用的方法 */
  onChange?: OnChangeHandler;
  /** label 标签的文本 */
  text?: string | FilterFunction<string>;
  /** 右侧感叹号 */
  tip?: string;

  filter?: 'number' | OnChangeHandler;
  /** 是否去除首尾空格 */
  trim?: boolean;
  /** 默认值 */
  defaultValue?: any | DefaultValueFunction;
  /** 表单验证规则 */
  rules?: Rule[];
  extensible?: boolean;
  dynamicKey?: string;
  /** 是否需要显示\`展开更多配置\` */
  expand?: boolean;
  style?: Record<string, any>;
  fieldStyle?: Record<string, any>;
  labelPosition?: 'top' | 'left' | 'right';
}

options item ​

参数说明类型可选值默认值
value选项的值string / number / boolean——
text选项的标签string——
icon选项的图标组件any——
tooltip鼠标悬停时显示的提示内容string——
`,7))])}const c=t(r,[["render",g]]);export{B as __pageData,c as default};