DateRangePicker 日期范围选择器

用于选择或输入日期范围

基础用法

type为'daterange'

[
  {
    type: "daterange",
    name: "daterange",
    text: "日期范围"
  }
]

显示配置

绑定多个字段

可以通过配置 names 来将日期范围绑定到两个不同的字段上。

配置 names 属性，将开始时间和结束时间分别绑定到 startTime 和 endTime 字段。

[
  {
    type: "daterange",
    names: [
      "startTime",
      "endTime"
    ],
    text: "日期范围"
  }
]

显示配置

Attributes

参数	说明	类型	可选值	默认值
name	绑定值（数组形式）	string	—	—
names	绑定值（拆分为两个字段）	string[]	—	—
text	表单标签	string	—	—
disabled	是否禁用	boolean / FilterFunction	—	false
dateFormat	日期格式	string	—	YYYY/MM/DD
timeFormat	时间格式	string	—	HH:mm:ss
valueFormat	绑定值的格式	string	—	YYYY/MM/DD HH:mm:ss
defaultTime	默认时间	Date[]	—	—
onChange	值变化时触发的函数	OnChangeHandler	—	-

查看 FilterFunction / 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>;

配置类型

查看 DaterangeConfig 配置类型定义

export interface DaterangeConfig extends FormItem {
  type: 'daterange';
  defaultTime?: Date[];
  names?: string[];
  valueFormat?: string;
  dateFormat?: string;
  timeFormat?: 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';
}