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":"TimeRangePicker 时间范围选择器","description":"","frontmatter":{},"headers":[],"relativePath":"form-config/fields/timerange-picker.md","filePath":"form-config/fields/timerange-picker.md"}'),d={name:"form-config/fields/timerange-picker.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:"timerangepicker-时间范围选择器",tabindex:"-1"},[a("TimeRangePicker 时间范围选择器 "),i("a",{class:"header-anchor",href:"#timerangepicker-时间范围选择器","aria-label":"Permalink to “TimeRangePicker 时间范围选择器”"},"​")],-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:"timerange",name:"timerange",text:"时间范围"}]},{source:t(()=>[...s[0]||(s[0]=[i("p",null," type为'timerange' ",-1)])]),_:1}),s[5]||(s[5]=i("h2",{id:"绑定多个字段",tabindex:"-1"},[a("绑定多个字段 "),i("a",{class:"header-anchor",href:"#绑定多个字段","aria-label":"Permalink to “绑定多个字段”"},"​")],-1)),s[6]||(s[6]=i("p",null,[a("可以通过配置 "),i("code",null,"names"),a(" 来将时间范围绑定到两个不同的字段上。")],-1)),h(n,{type:"form",config:[{type:"timerange",names:["startTime","endTime"],text:"时间范围"}]},{source:t(()=>[...s[1]||(s[1]=[i("p",null," 配置 names 属性，将开始时间和结束时间分别绑定到 startTime 和 endTime 字段。 ",-1)])]),_:1}),s[7]||(s[7]=r(`

Attributes ​

参数说明类型可选值默认值
name绑定值（数组形式）string——
names绑定值（拆分为两个字段）string[]——
text表单标签string——
disabled是否禁用boolean / FilterFunction—false
format显示格式string—HH:mm:ss
valueFormat绑定值的格式string—HH:mm:ss
defaultTime默认时间Date[]——
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>;

配置类型 ​

查看 TimerangeConfig 配置类型定义
ts
export interface TimerangeConfig extends FormItem {
  type: 'timerange';
  names?: string[];
  defaultTime?: Date[];
  format?: 'HH:mm:ss' | string;
  valueFormat?: 'HH:mm:ss' | 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=k(d,[["render",g]]);export{c as __pageData,B as default};