import{H as e,It as t,Mt as n,dt as r,ft as i,lt as a,ot as o,pt as s,qt as c}from"./chunks/framework.BTDV-FQ9.js";var l=JSON.parse(`{"title":"DateTimePicker 日期时间选择器","description":"","frontmatter":{},"headers":[],"relativePath":"form-config/fields/datetime-picker.md","filePath":"form-config/fields/datetime-picker.md"}`),u={name:`form-config/fields/datetime-picker.md`};function d(e,l,u,d,f,p){let m=t(`demo-block`);return n(),a(`div`,null,[l[4]||=o(`h1`,{id:`datetimepicker-日期时间选择器`,tabindex:`-1`},[i(`DateTimePicker 日期时间选择器 `),o(`a`,{class:`header-anchor`,href:`#datetimepicker-日期时间选择器`,"aria-label":`Permalink to “DateTimePicker 日期时间选择器”`},`​`)],-1),l[5]||=o(`p`,null,`在同一个选择器里选择日期和时间`,-1),l[6]||=o(`h2`,{id:`基础用法`,tabindex:`-1`},[i(`基础用法 `),o(`a`,{class:`header-anchor`,href:`#基础用法`,"aria-label":`Permalink to “基础用法”`},`​`)],-1),s(m,{type:`form`,config:[{type:`datetime`,name:`dateTime`,text:`日期时间选择器`}]},{source:c(()=>[...l[0]||=[o(`p`,null,[i(` 通过设置 `),o(`code`,null,`type: 'datetime'`),i(` 使用日期时间选择器，可以同时选择日期和时间。 `)],-1)]]),_:1}),l[7]||=o(`h2`,{id:`带占位符`,tabindex:`-1`},[i(`带占位符 `),o(`a`,{class:`header-anchor`,href:`#带占位符`,"aria-label":`Permalink to “带占位符”`},`​`)],-1),s(m,{type:`form`,config:[{type:`datetime`,name:`dateTime`,text:`日期时间选择器`,placeholder:`请选择日期时间`}]},{source:c(()=>[...l[1]||=[o(`p`,null,[i(` 通过 `),o(`code`,null,`placeholder`),i(` 属性设置输入框的占位文本。 `)],-1)]]),_:1}),l[8]||=o(`h2`,{id:`禁用状态`,tabindex:`-1`},[i(`禁用状态 `),o(`a`,{class:`header-anchor`,href:`#禁用状态`,"aria-label":`Permalink to “禁用状态”`},`​`)],-1),s(m,{type:`form`,config:[{type:`datetime`,name:`dateTime`,text:`日期时间选择器`,disabled:()=>!0}]},{source:c(()=>[...l[2]||=[o(`p`,null,[i(` 通过 `),o(`code`,null,`disabled`),i(` 属性禁用日期时间选择器，支持布尔值或函数。 `)],-1)]]),_:1}),l[9]||=r(`

日期格式 ​

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

默认情况下，组件接受并返回格式化后的字符串。以下为可用的格式化字串，以 UTC 2017年1月2日 03:04:05 为例：

WARNING

请注意大小写

格式含义备注举例
YYYY年2017
M月不补01
MM月01
D日不补02
DD日02
H小时24小时制；不补03
HH小时24小时制03
h小时12小时制，须和 A 或 a 使用；不补03
hh小时12小时制，须和 A 或 a 使用03
m分钟不补04
mm分钟04
s秒不补05
ss秒05
AAM/PM仅 format 可用，大写AM
aam/pm仅 format 可用，小写am
xJS时间戳（毫秒）仅 valueFormat 可用1483326245000
XUnix时间戳（秒）仅 valueFormat 可用1483326245
`,5),s(m,{type:`form`,config:[{type:`datetime`,name:`dateTime`,text:`日期时间选择器`,format:`YYYY-MM-DD HH:mm`,valueFormat:`x`}]},{source:c(()=>[...l[3]||=[o(`p`,null,[i(` 自定义格式化：显示格式为 `),o(`code`,null,`YYYY-MM-DD HH:mm`),i(`，绑定值格式为时间戳。 `)],-1)]]),_:1}),l[10]||=r(`

Attributes ​

参数说明类型可选值默认值
name绑定值的字段名string——
text表单标签string——
placeholder输入框占位文本string——
disabled是否禁用boolean / FilterFunction—false
format显示在输入框中的格式string见日期格式YYYY/MM/DD HH:mm:ss
valueFormat绑定值的格式string见日期格式YYYY/MM/DD 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>;

配置类型 ​

查看 DateTimeConfig 配置类型定义
ts
export interface DateTimeConfig extends FormItem, Input {
  type: 'datetime';
  defaultTime?: 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>;
  /** 额外的提示信息，和 extra 类似，着重强调时用这个显示，优先级高于extra*/
  extraTips?: 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;
  /** 标题下方的额外提示信息 */
  titleExtra?: string;
  /** 表单验证规则 */
  rules?: Rule[];
  extensible?: boolean;
  dynamicKey?: string;
  /** 是否需要显示\`展开更多配置\` */
  expand?: boolean;
  style?: Record<string, any>;
  fieldStyle?: Record<string, any>;
  labelPosition?: 'top' | 'left' | 'right';
  flat?: boolean;
  fixed?: boolean | 'left' | 'right';
  operateColWidth?: number | string;
}
ts
export interface Input {
  /** 输入框没有内容时显示的文案 */
  placeholder?: string;
}
`,5)])}var f=e(u,[[`render`,d]]);export{l as __pageData,f as default};