--- category: Components subtitle: 时间选择框 type: 数据录入 title: TimePicker cover: https://gw.alipayobjects.com/zos/alicdn/h04Zsl98I/TimePicker.svg --- 输入或选择时间的控件。 ## 何时使用 --- 当用户需要输入一个时间,可以点击标准输入框,弹出时间面板进行选择。 ## API --- ```jsx import moment from 'moment'; ; ``` | 参数 | 说明 | 类型 | 默认值 | 版本 | | --- | --- | --- | --- | --- | | allowClear | 是否展示清除按钮 | boolean | true | | | autoFocus | 自动获取焦点 | boolean | false | | | bordered | 是否有边框 | boolean | true | | | className | 选择器类名 | string | - | | | clearText | 清除按钮的提示文案 | string | clear | | | defaultValue | 默认时间 | [moment](http://momentjs.com/) | - | | | 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 | 面板是否打开 | boolean | false | | | placeholder | 没有值的时候显示的内容 | string \| \[string, string] | `请选择时间` | | | popupClassName | 弹出层类名 | string | - | | | popupStyle | 弹出层样式对象 | object | - | | | secondStep | 秒选项间隔 | number | 1 | | | suffixIcon | 自定义的选择框后缀图标 | ReactNode | - | | | clearIcon | 自定义的清除图标 | ReactNode | - | | | renderExtraFooter | 选择框底部显示自定义的内容 | () => ReactNode | - | | | use12Hours | 使用 12 小时制,为 true 时 `format` 默认为 `h:mm:ss a` | boolean | false | | | value | 当前时间 | [moment](http://momentjs.com/) | - | | | onChange | 时间发生变化的回调 | function(time: moment, timeString: string): void | - | | | onOpenChange | 面板打开/关闭时的回调 | (open: boolean) => void | - | | | showNow | 面板是否显示“此刻”按钮 | boolean | - | 4.4.0 | ## 方法 | 名称 | 描述 | 版本 | | ------- | -------- | ---- | | blur() | 移除焦点 | | | focus() | 获取焦点 | | ### RangePicker 属性与 DatePicker 的 [RangePicker](/components/date-picker/#RangePicker) 相同。还包含以下属性: | 参数 | 说明 | 类型 | 默认值 | 版本 | | ----- | -------------------- | ------- | ------ | ----- | | order | 始末时间是否自动排序 | boolean | true | 4.1.0 | ## FAQ - [如何在 TimePicker 中使用自定义日期库(如 dayjs )](/docs/react/replace-moment#TimePicker)