ant-design-vue/components/time-picker/index.zh-CN.md

3.3 KiB
Raw Blame History

category type title subtitle cover
Components 数据录入 TimePicker 时间选择框 https://gw.alipayobjects.com/zos/alicdn/h04Zsl98I/TimePicker.svg

输入或选择时间的控件。

何时使用

当用户需要输入一个时间,可以点击标准输入框,弹出时间面板进行选择。

API

参数 说明 类型 默认值 版本
allowClear 是否展示清除按钮 boolean true
autofocus 自动获取焦点 boolean false
bordered 是否有边框 boolean true
clearIcon 自定义的清除图标 v-slot:clearIcon -
clearText 清除按钮的提示文案 string clear
disabled 禁用全部操作 boolean false
disabledHours 禁止选择部分小时选项 function() -
disabledMinutes 禁止选择部分分钟选项 function(selectedHour) -
disabledSeconds 禁止选择部分秒选项 function(selectedHour, selectedMinute) -
format 展示的时间格式 string HH:mm:ss
getPopupContainer 定义浮层的容器,默认为 body 上新建 div function(trigger) -
hideDisabledOptions 隐藏禁止选择的选项 boolean false
hourStep 小时选项间隔 number 1
inputReadOnly 设置输入框为只读(避免在移动设备上打开虚拟键盘) boolean false
minuteStep 分钟选项间隔 number 1
open(v-model) 面板是否打开 boolean false
placeholder 没有值的时候显示的内容 string | [string, string] 请选择时间
popupClassName 弹出层类名 string -
popupStyle 弹出层样式对象 object -
renderExtraFooter 选择框底部显示自定义的内容 v-slot:renderExtraFooter -
secondStep 秒选项间隔 number 1
showNow 面板是否显示“此刻”按钮 boolean -
suffixIcon 自定义的选择框后缀图标 v-slot:suffixIcon -
use12Hours 使用 12 小时制,为 true 时 format 默认为 h:mm:ss a boolean false
value(v-model) 当前时间 dayjs -
valueFormat 可选,绑定值的格式,对 value、defaultValue 起作用。不指定则绑定值为 dayjs 对象 string具体格式 -

事件

事件名称 说明 回调参数
change 时间发生变化的回调 function(time: dayjs | string, timeString: string): void
openChange 面板打开/关闭时的回调 (open: boolean): void

方法

名称 描述
blur() 移除焦点
focus() 获取焦点

TimeRangePicker

属性与 DatePicker 的 RangePicker 相同。还包含以下属性:

参数 说明 类型 默认值 版本
order 始末时间是否自动排序 boolean true

FAQ

如何在 DatePicker 中使用自定义日期库(如 moment.js | dayjs | date-fns

请参考《自定义日期库》