import{ax as l,al as k,z as p,A as e,B as i,R as h,b5 as r,O as a,J as t}from"./chunks/framework.V2ssSR2R.js";const C=JSON.parse('{"title":"Switch 开关","description":"","frontmatter":{},"headers":[],"relativePath":"form-config/fields/switch.md","filePath":"form-config/fields/switch.md"}'),d={name:"form-config/fields/switch.md"};function g(F,s,y,E,o,c){const n=k("demo-block");return e(),p("div",null,[s[2]||(s[2]=i("h1",{id:"switch-开关",tabindex:"-1"},[a("Switch 开关 "),i("a",{class:"header-anchor",href:"#switch-开关","aria-label":"Permalink to “Switch 开关”"},"​")],-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)),h(n,{type:"form",config:[{type:"switch",name:"switch",text:"开关"}]}),s[5]||(s[5]=i("h2",{id:"扩展的-value-类型",tabindex:"-1"},[a("扩展的 value 类型 "),i("a",{class:"header-anchor",href:"#扩展的-value-类型","aria-label":"Permalink to “扩展的 value 类型”"},"​")],-1)),h(n,{type:"form",config:[{type:"switch",name:"switch",text:"开关",activeValue:"on",inactiveValue:"off"}]},{source:t(()=>[...s[0]||(s[0]=[i("p",null," 设置 activeValue 和 inactiveValue 属性，接受 Boolean , String 或 Number 类型的值。 ",-1)])]),_:1}),s[6]||(s[6]=i("h2",{id:"禁用状态",tabindex:"-1"},[a("禁用状态 "),i("a",{class:"header-anchor",href:"#禁用状态","aria-label":"Permalink to “禁用状态”"},"​")],-1)),h(n,{type:"form",config:[{type:"switch",name:"switch",text:"开关",disabled:!0}]},{source:t(()=>[...s[1]||(s[1]=[i("p",null," 设置 disabled 属性，接受一个 Boolean，设置 true 即可禁用。 ",-1)])]),_:1}),s[7]||(s[7]=r(`

Attributes ​

参数说明类型可选值默认值
name绑定值string——
disabled是否禁用boolean / FilterFunction—false
active-valueswitch 打开时的值boolean / string / number—true
inactive-valueswitch 关闭时的值boolean / string / number—false
查看 FilterFunction 及关联类型定义
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;

配置类型 ​

查看 SwitchConfig 配置类型定义
ts
export interface SwitchConfig extends FormItem {
  type: 'switch';
  activeValue?: boolean | number | string;
  inactiveValue?: boolean | number | 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';
}
`,5))])}const B=l(d,[["render",g]]);export{C as __pageData,B as default};