import{ax as k,al as l,z as p,A as e,B as i,R as n,b5 as d,O as t,J as h}from"./chunks/framework.V2ssSR2R.js";const f=JSON.parse('{"title":"Input 输入框","description":"","frontmatter":{},"headers":[],"relativePath":"form-config/fields/text.md","filePath":"form-config/fields/text.md"}'),r={name:"form-config/fields/text.md"};function g(F,s,E,y,o,A){const a=l("demo-block");return e(),p("div",null,[s[7]||(s[7]=i("h1",{id:"input-输入框",tabindex:"-1"},[t("Input 输入框 "),i("a",{class:"header-anchor",href:"#input-输入框","aria-label":"Permalink to “Input 输入框”"},"​")],-1)),s[8]||(s[8]=i("p",null,"通过鼠标或键盘输入字符",-1)),s[9]||(s[9]=i("h2",{id:"基础用法",tabindex:"-1"},[t("基础用法 "),i("a",{class:"header-anchor",href:"#基础用法","aria-label":"Permalink to “基础用法”"},"​")],-1)),n(a,{type:"form",config:[{name:"text",text:"输入框"}]},{source:h(()=>[...s[0]||(s[0]=[i("p",null," Input输入框的type为'text', 是type的默认值，所以可以不配置 ",-1)])]),_:1}),s[10]||(s[10]=i("h2",{id:"禁用状态",tabindex:"-1"},[t("禁用状态 "),i("a",{class:"header-anchor",href:"#禁用状态","aria-label":"Permalink to “禁用状态”"},"​")],-1)),n(a,{type:"form",config:[{name:"text",text:"输入框",disabled:()=>!0}]},{source:h(()=>[...s[1]||(s[1]=[i("p",null," 通过 disabled 属性指定是否禁用 input 组件 ",-1)])]),_:1}),s[11]||(s[11]=i("h2",{id:"复合型输入框",tabindex:"-1"},[t("复合型输入框 "),i("a",{class:"header-anchor",href:"#复合型输入框","aria-label":"Permalink to “复合型输入框”"},"​")],-1)),s[12]||(s[12]=i("p",null,"后置内容",-1)),n(a,{type:"form",config:[{name:"text",text:"重量",append:"公斤"}]},{source:h(()=>[...s[2]||(s[2]=[i("p",null," 可以通过配置append来增加一个后置内容。 ",-1)])]),_:1}),n(a,{type:"form",config:[{name:"text",text:"输入框",append:{type:"button",text:"操作",handler:(C,{model:B,values:c,formValue:D,setModel:u,setFormValue:b})=>{}}}]},{source:h(()=>[...s[3]||(s[3]=[i("p",null," 可以通过配置append来增加一个后置按钮。 ",-1)])]),_:1}),s[13]||(s[13]=i("h2",{id:"过滤内容",tabindex:"-1"},[t("过滤内容 "),i("a",{class:"header-anchor",href:"#过滤内容","aria-label":"Permalink to “过滤内容”"},"​")],-1)),n(a,{type:"form",config:[{name:"text",text:"输入框",filter:"number"}]},{source:h(()=>[...s[4]||(s[4]=[i("p",null," 设置filter为'number'，可以将值转换成数值，也可以配置一个函数来自由转换。 ",-1)])]),_:1}),s[14]||(s[14]=i("h2",{id:"去掉首尾空格",tabindex:"-1"},[t("去掉首尾空格 "),i("a",{class:"header-anchor",href:"#去掉首尾空格","aria-label":"Permalink to “去掉首尾空格”"},"​")],-1)),n(a,{type:"form",config:[{name:"text",text:"输入框",trim:!0}]},{source:h(()=>[...s[5]||(s[5]=[i("p",null," 设置trim为true'，可以去掉首尾空格。 ",-1)])]),_:1}),s[15]||(s[15]=i("h2",{id:"显示详情",tabindex:"-1"},[t("显示详情 "),i("a",{class:"header-anchor",href:"#显示详情","aria-label":"Permalink to “显示详情”"},"​")],-1)),n(a,{type:"form",config:[{name:"text",text:"输入框",tooltip:!0}]},{source:h(()=>[...s[6]||(s[6]=[i("p",null," 通过配置 tooltip，在输入时显示提示内容。 ",-1)])]),_:1}),s[16]||(s[16]=d(`

Input Attributes ​

参数说明类型可选值默认值
name绑定值string——
text表单标签string——
placeholder输入框占位文本string——
disabled是否禁用boolean / FilterFunction—false
clearable是否可清空boolean—true
tooltip输入时显示内容string / ToolTipConfigType——
trim是否去掉首尾空格boolean—false
filter过滤值string / Functionnumber-
prepend前置内容string—-
append后置内容string / Object—-
onChange值变化时触发的函数OnChangeHandler—-
查看 FilterFunction / OnChangeHandler / ToolTipConfigType 及关联类型定义
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>;
ts
export type ToolTipConfigType = string | { text?: string; placement?: string };

配置类型 ​

查看 TextConfig 配置类型定义
ts
export interface TextConfig extends FormItem, Input {
  type?: 'text';
  tooltip?: string;
  /** 是否可清空 */
  clearable?: boolean;
  prepend?: string;
  /** 后置元素，一般为标签或按钮 */
  append?:
    | string
    | {
        text: string;
        value?: 0 | 1;
        type: 'button';
        handler?: (
          mForm: FormState | undefined,
          data: {
            model: any;
            values?: Readonly<FormValue> | null;
            formValue?: FormValue;
            setModel: (prop: string, value: any) => void;
            setFormValue: (prop: string, value: any) => void;
          },
        ) => void | Promise<void>;
      };
}
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 interface Input {
  /** 输入框没有内容时显示的文案 */
  placeholder?: string;
}

append Attributes ​

参数说明类型可选值默认值
type内容类型stringbutton—
text文本内容string——
handler点击操作Function—-
`,7))])}const x=k(r,[["render",g]]);export{f as __pageData,x as default};