import{ax as k,al as l,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":"InputNumber 计数器","description":"","frontmatter":{},"headers":[],"relativePath":"form-config/fields/number.md","filePath":"form-config/fields/number.md"}'),d={name:"form-config/fields/number.md"};function g(F,s,y,E,o,A){const n=l("demo-block");return e(),p("div",null,[s[3]||(s[3]=i("h1",{id:"inputnumber-计数器",tabindex:"-1"},[a("InputNumber 计数器 "),i("a",{class:"header-anchor",href:"#inputnumber-计数器","aria-label":"Permalink to “InputNumber 计数器”"},"")],-1)),s[4]||(s[4]=i("p",null,"仅允许输入标准的数字值,可定义范围",-1)),s[5]||(s[5]=i("h2",{id:"基础用法",tabindex:"-1"},[a("基础用法 "),i("a",{class:"header-anchor",href:"#基础用法","aria-label":"Permalink to “基础用法”"},"")],-1)),h(n,{type:"form",config:[{type:"number",name:"number",text:"计数器"}]},{source:t(()=>[...s[0]||(s[0]=[i("p",null," type为'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:"number",name:"number",text:"计数器",disabled:()=>!0}]},{source:t(()=>[...s[1]||(s[1]=[i("p",null," disabled 属性接受一个 Boolean,设置为 true 即可禁用整个组件,也可以接受一个返回 Boolean 的函数,如果你只需要控制数值在某一范围内,可以设置 min 属性和 max 属性,不设置 min 和 max 时,最小值为 0。 ",-1)])]),_:1}),s[7]||(s[7]=i("h2",{id:"步数",tabindex:"-1"},[a("步数 "),i("a",{class:"header-anchor",href:"#步数","aria-label":"Permalink to “步数”"},"")],-1)),s[8]||(s[8]=i("p",null,"允许定义递增递减的步数控制",-1)),h(n,{type:"form",config:[{type:"number",name:"number",text:"计数器",step:10}]},{source:t(()=>[...s[2]||(s[2]=[i("p",null," 设置 step 属性可以控制步长,接受一个 Number 。 ",-1)])]),_:1}),s[9]||(s[9]=r(`
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| name | 绑定值 | string | — | — |
| text | 表单标签 | string | — | — |
| placeholder | 输入框占位文本 | string | — | — |
| disabled | 是否禁用 | boolean / FilterFunction | — | false |
| min | 设置计数器允许的最小值 | number | — | -Infinity |
| max | 设置计数器允许的最大值 | number | — | Infinity |
| step | 计数器步长 | number | — | 1 |
| tooltip | 输入框提示信息 | string | — | — |
| onChange | 值变化时触发的函数 | OnChangeHandler | — | - |
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;export type OnChangeHandler = (mForm: FormState | undefined, value: any, data: OnChangeHandlerData) => any;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;
}export interface ChangeRecord {
propPath?: string;
value: any;
}export type FormValue = Record<string | number, any>;export interface NumberConfig extends FormItem {
type?: 'number';
tooltip?: string;
min?: number;
max?: number;
step?: number;
placeholder?: string;
}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';
}