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

64 lines
2.5 KiB
Markdown
Raw Normal View History

2016-03-31 14:17:09 +08:00
---
category: Components
2016-09-21 11:28:38 +08:00
subtitle: 时间选择框
type: 数据录入
2016-09-21 11:28:38 +08:00
title: TimePicker
2016-03-31 14:17:09 +08:00
---
2015-11-16 23:11:41 +08:00
输入或选择时间的控件。
2016-07-26 11:03:44 +08:00
## 何时使用
2017-10-25 10:25:44 +08:00
* * *
2015-11-16 23:11:41 +08:00
当用户需要输入一个时间,可以点击标准输入框,弹出时间面板进行选择。
2016-07-26 11:03:44 +08:00
## API
2017-10-25 10:25:44 +08:00
* * *
2015-11-16 23:11:41 +08:00
```jsx
import moment from 'moment';
<TimePicker defaultValue={moment('13:30:56', 'HH:mm:ss')} />
2015-11-16 23:11:41 +08:00
```
2017-10-25 10:25:44 +08:00
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| addon | 选择框底部显示自定义的内容 | function | 无 |
| allowClear | 是否展示清除按钮 | boolean | true |
| autoFocus | 自动获取焦点 | boolean | false |
| className | 选择器类名 | string | '' |
2017-11-03 15:02:26 +08:00
| clearText | 清除按钮的提示文案 | string | clear |
| defaultOpenValue | 当 defaultValue/value 不存在时,可以设置面板打开时默认选中的值 | [moment](http://momentjs.com/) | moment() |
2017-10-25 10:25:44 +08:00
| 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 |
2017-12-29 20:22:58 +08:00
| hourStep | 小时选项间隔 | number | 1 |
2018-06-24 17:09:18 +08:00
| inputReadOnly | 设置输入框为只读(避免在移动设备上打开虚拟键盘) | boolean | false |
2017-12-29 20:22:58 +08:00
| minuteStep | 分钟选项间隔 | number | 1 |
2017-10-25 10:25:44 +08:00
| open | 面板是否打开 | boolean | false |
| placeholder | 没有值的时候显示的内容 | string | "请选择时间" |
| popupClassName | 弹出层类名 | string | '' |
| popupStyle | 弹出层样式对象 | object | - |
2017-12-29 20:22:58 +08:00
| secondStep | 秒选项间隔 | number | 1 |
2018-09-16 19:45:27 +08:00
| suffixIcon | 自定义的选择框后缀图标 | ReactNode | - |
| clearIcon | 自定义的清除图标 | ReactNode | - |
2017-10-25 10:25:44 +08:00
| 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 | 无 |
2015-11-16 23:11:41 +08:00
## 方法
| 名称 | 描述 |
2017-12-29 20:22:58 +08:00
| --- | --- |
| blur() | 移除焦点 |
2017-12-29 20:22:58 +08:00
| focus() | 获取焦点 |
2015-12-11 19:58:41 +08:00
<style>.code-box-demo .ant-time-picker { margin: 0 8px 12px 0; }</style>