ant-design/components/time-picker/index.en-US.md

63 lines
2.8 KiB
Markdown
Raw Normal View History

2016-07-26 11:03:44 +08:00
---
category: Components
type: Data Entry
2016-07-26 11:03:44 +08:00
title: TimePicker
---
To select/input a time.
2016-09-10 13:43:30 +08:00
## When To Use
2017-10-25 10:25:44 +08:00
* * *
2016-07-26 11:03:44 +08:00
By clicking the input box, you can select a time from a popup panel.
## API
2017-10-25 10:25:44 +08:00
* * *
2016-07-26 11:03:44 +08:00
```jsx
import moment from 'moment';
<TimePicker defaultValue={moment('13:30:56', 'HH:mm:ss')} />
2016-07-26 11:03:44 +08:00
```
2017-10-25 10:25:44 +08:00
| Property | Description | Type | Default |
| -------- | ----------- | ---- | ------- |
| addon | called from timepicker panel to render some addon to its bottom | function | - |
| allowClear | allow clearing text | boolean | true |
| autoFocus | get focus when component mounted | boolean | false |
| className | className of picker | string | '' |
2017-11-03 15:02:26 +08:00
| clearText | clear tooltip of icon | string | clear |
| defaultOpenValue | default open panel value, used to set utcOffset,locale if value/defaultValue absent | [moment](http://momentjs.com/) | moment() |
2017-10-25 10:25:44 +08:00
| defaultValue | to set default time | [moment](http://momentjs.com/) | - |
| disabled | determine whether the TimePicker is disabled | boolean | false |
| disabledHours | to specify the hours that cannot be selected | function() | - |
| disabledMinutes | to specify the minutes that cannot be selected | function(selectedHour) | - |
| disabledSeconds | to specify the seconds that cannot be selected | function(selectedHour, selectedMinute) | - |
| format | to set the time format | string | "HH:mm:ss" |
| getPopupContainer | to set the container of the floating layer, while the default is to create a div element in body | function(trigger) | - |
| hideDisabledOptions | hide the options that can not be selected | boolean | false |
2017-12-29 20:22:58 +08:00
| hourStep | interval between hours in picker | number | 1 |
2018-02-11 10:28:17 +08:00
| inputReadOnly | Set the `readonly` attribute of the input tag (avoids virtual keyboard on touch devices) | boolean | false |
2017-12-29 20:22:58 +08:00
| minuteStep | interval between minutes in picker | number | 1 |
2017-10-25 10:25:44 +08:00
| open | whether to popup panel | boolean | false |
| placeholder | display when there's no value | string | "Select a time" |
| popupClassName | className of panel | string | '' |
| popupStyle | style of panel | object | - |
2017-12-29 20:22:58 +08:00
| secondStep | interval between seconds in picker | number | 1 |
2018-09-16 19:45:27 +08:00
| suffixIcon | The custom suffix icon | ReactNode | - |
| clearIcon | The custom clear icon | ReactNode | - |
2017-10-25 10:25:44 +08:00
| use12Hours | display as 12 hours format, with default format `h:mm:ss a` | boolean | false |
| value | to set time | [moment](http://momentjs.com/) | - |
| onChange | a callback function, can be executed when the selected time is changing | function(time: moment, timeString: string): void | - |
| onOpenChange | a callback function which will be called while panel opening/closing | (open: boolean): void | - |
2016-07-26 11:03:44 +08:00
## Methods
| Name | Description |
| ---- | ----------- |
| blur() | remove focus |
2017-12-29 20:22:58 +08:00
| focus() | get focus |
2016-07-26 11:03:44 +08:00
<style>.code-box-demo .ant-time-picker { margin: 0 8px 12px 0; }</style>