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/DD,valueFormat 默认值为 YYYY/MM/DD。以下为可用的格式化字串,以 UTC 2017年1月2日 03:04:05 为例:
WARNING
请注意大小写
| 格式 | 含义 | 备注 | 举例 |
|---|---|---|---|
YYYY | 年 | 2017 | |
M | 月 | 不补0 | 1 |
MM | 月 | 01 | |
D | 日 | 不补0 | 2 |
DD | 日 | 02 | |
H | 小时 | 24小时制;不补0 | 3 |
HH | 小时 | 24小时制 | 03 |
h | 小时 | 12小时制,须和 A 或 a 使用;不补0 | 3 |
hh | 小时 | 12小时制,须和 A 或 a 使用 | 03 |
m | 分钟 | 不补0 | 4 |
mm | 分钟 | 04 | |
s | 秒 | 不补0 | 5 |
ss | 秒 | 05 | |
x | JS时间戳 | 组件绑定值为number类型 | 1483326245000 |
[MM] | 不需要格式化字符 | 使用方括号标识不需要格式化的字符 (如 [A] [MM]) | MM |
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| name | 绑定值的字段名 | string | — | — |
| text | 表单标签 | string | — | — |
| placeholder | 输入框占位文本 | string | — | — |
| disabled | 是否禁用 | boolean / FilterFunction | — | false |
| format | 显示在输入框中的格式 | string | 见日期格式 | YYYY/MM/DD |
| valueFormat | 绑定值的格式。不指定则绑定值为 Date 对象 | string | 见日期格式 | YYYY/MM/DD |
| 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 DateConfig extends FormItem, Input {
type: 'date';
format?: 'YYYY-MM-dd HH:mm:ss' | string;
valueFormat?: 'YYYY-MM-dd HH:mm:ss' | 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';
}export interface Input {
/** 输入框没有内容时显示的文案 */
placeholder?: string;
}interface DateConfig extends FormItem, Input {
type: "date";
format?: "YYYY-MM-dd HH:mm:ss" | string;
valueFormat?: "YYYY-MM-dd HH:mm:ss" | string;
}