import{ax as l,al as p,z as e,A as d,B as i,R as n,b5 as k,O as a,J as h}from"./chunks/framework.V2ssSR2R.js";const C=JSON.parse('{"title":"DatePicker 日期选择器","description":"","frontmatter":{},"headers":[],"relativePath":"form-config/fields/date-picker.md","filePath":"form-config/fields/date-picker.md"}'),r={name:"form-config/fields/date-picker.md"};function g(F,s,y,E,o,c){const t=p("demo-block");return d(),e("div",null,[s[4]||(s[4]=i("h1",{id:"datepicker-日期选择器",tabindex:"-1"},[a("DatePicker 日期选择器 "),i("a",{class:"header-anchor",href:"#datepicker-日期选择器","aria-label":"Permalink to “DatePicker 日期选择器”"},"​")],-1)),s[5]||(s[5]=i("p",null,"用于选择或输入日期",-1)),s[6]||(s[6]=i("h2",{id:"基础用法",tabindex:"-1"},[a("基础用法 "),i("a",{class:"header-anchor",href:"#基础用法","aria-label":"Permalink to “基础用法”"},"​")],-1)),n(t,{type:"form",config:[{type:"date",name:"date",text:"日期选择器"}]},{source:h(()=>[...s[0]||(s[0]=[i("p",null," 以日期为基本单位,基础的日期选择控件 ",-1)])]),_:1}),s[7]||(s[7]=i("h2",{id:"禁用状态",tabindex:"-1"},[a("禁用状态 "),i("a",{class:"header-anchor",href:"#禁用状态","aria-label":"Permalink to “禁用状态”"},"​")],-1)),n(t,{type:"form",config:[{type:"date",name:"date",text:"日期选择器",disabled:()=>!0}]},{source:h(()=>[...s[1]||(s[1]=[i("p",null,[a(" 通过 "),i("code",null,"disabled"),a(" 属性禁用日期选择器 ")],-1)])]),_:1}),s[8]||(s[8]=i("h2",{id:"占位符",tabindex:"-1"},[a("占位符 "),i("a",{class:"header-anchor",href:"#占位符","aria-label":"Permalink to “占位符”"},"​")],-1)),n(t,{type:"form",config:[{type:"date",name:"date",text:"日期选择器",placeholder:"请选择日期"}]},{source:h(()=>[...s[2]||(s[2]=[i("p",null,[a(" 通过 "),i("code",null,"placeholder"),a(" 属性设置输入框占位文本 ")],-1)])]),_:1}),s[9]||(s[9]=k('

日期格式

使用format指定输入框的格式;使用valueFormat指定绑定值的格式。

默认情况下,组件的 format 默认值为 YYYY/MM/DDvalueFormat 默认值为 YYYY/MM/DD。以下为可用的格式化字串,以 UTC 2017年1月2日 03:04:05 为例:

WARNING

请注意大小写

格式含义备注举例
YYYY2017
M不补01
MM01
D不补02
DD02
H小时24小时制;不补03
HH小时24小时制03
h小时12小时制,须和 Aa 使用;不补03
hh小时12小时制,须和 Aa 使用03
m分钟不补04
mm分钟04
s不补05
ss05
xJS时间戳组件绑定值为number类型1483326245000
[MM]不需要格式化字符使用方括号标识不需要格式化的字符 (如 [A] [MM])MM
',5)),n(t,{type:"form",config:[{type:"date",name:"date",text:"日期选择器",format:"YYYY-MM-DD",valueFormat:"x"}]},{source:h(()=>[...s[3]||(s[3]=[i("p",null,[a(" 设置 "),i("code",null,"valueFormat"),a(" 为 "),i("code",null,"timestamp"),a(",绑定值将返回时间戳格式 ")],-1)])]),_:1}),s[10]||(s[10]=k(`

Attributes

参数说明类型可选值默认值
name绑定值的字段名string
text表单标签string
placeholder输入框占位文本string
disabled是否禁用boolean / FilterFunctionfalse
format显示在输入框中的格式string日期格式YYYY/MM/DD
valueFormat绑定值的格式。不指定则绑定值为 Date 对象string日期格式YYYY/MM/DD
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>;

配置类型

查看 DateConfig 配置类型定义
ts
export interface DateConfig extends FormItem, Input {
  type: 'date';
  format?: 'YYYY-MM-dd HH:mm:ss' | string;
  valueFormat?: 'YYYY-MM-dd 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';
}
ts
export interface Input {
  /** 输入框没有内容时显示的文案 */
  placeholder?: string;
}

TypeScript 定义

typescript
interface DateConfig extends FormItem, Input {
  type: "date";
  format?: "YYYY-MM-dd HH:mm:ss" | string;
  valueFormat?: "YYYY-MM-dd HH:mm:ss" | string;
}
`,7))])}const B=l(r,[["render",g]]);export{C as __pageData,B as default};