import{At as e,E as t,Mt as n,Ot as r,Tt as i,Xt as a,dn as o,en as s,jt as c}from"./chunks/framework.ECw2lWOt.js";var l=JSON.parse(`{"title":"NumberRange 数字范围输入框","description":"","frontmatter":{},"headers":[],"relativePath":"form-config/fields/number-range.md","filePath":"form-config/fields/number-range.md"}`),u={name:`form-config/fields/number-range.md`};function d(t,l,u,d,f,p){let m=s(`demo-block`);return a(),r(`div`,null,[l[1]||=i(`h1`,{id:`numberrange-数字范围输入框`,tabindex:`-1`},[c(`NumberRange 数字范围输入框 `),i(`a`,{class:`header-anchor`,href:`#numberrange-数字范围输入框`,"aria-label":`Permalink to “NumberRange 数字范围输入框”`},`​`)],-1),l[2]||=i(`p`,null,`用于输入数字范围`,-1),l[3]||=i(`h2`,{id:`基础用法`,tabindex:`-1`},[c(`基础用法 `),i(`a`,{class:`header-anchor`,href:`#基础用法`,"aria-label":`Permalink to “基础用法”`},`​`)],-1),n(m,{type:`form`,config:[{type:`number-range`,name:`numberRange`,text:`数字范围`}]},{source:o(()=>[...l[0]||=[i(`p`,null,` type为'number-range' `,-1)]]),_:1}),l[4]||=e(`

Attributes

参数说明类型可选值默认值
name绑定值(数组形式 [min, max])string
text表单标签string
disabled是否禁用boolean / FilterFunctionfalse
clearable是否可清空booleantrue
onChange值变化时触发的函数OnChangeHandler-
查看 FilterFunction / OnChangeHandler 及关联类型定义
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>;

配置类型

查看 NumberRangeConfig 配置类型定义
ts
export interface NumberRangeConfig extends FormItem {
  type?: 'number-range';
  clearable?: boolean;
}
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>;
  /** 额外的提示信息,和 extra 类似,着重强调时用这个显示,优先级高于extra*/
  extraTips?: 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;
  /** 标题下方的额外提示信息 */
  titleExtra?: string;
  /** 表单验证规则 */
  rules?: Rule[];
  extensible?: boolean;
  dynamicKey?: string;
  /** 是否需要显示\`展开更多配置\` */
  expand?: boolean;
  style?: Record<string, any>;
  fieldStyle?: Record<string, any>;
  labelPosition?: 'top' | 'left' | 'right';
  flat?: boolean;
  fixed?: boolean | 'left' | 'right';
  operateColWidth?: number | string;
}
`,5)])}var f=t(u,[[`render`,d]]);export{l as __pageData,f as default};