2016-07-26 11:03:44 +08:00
|
|
|
---
|
|
|
|
|
category: Components
|
2016-11-09 14:43:32 +08:00
|
|
|
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
|
|
|
|
2019-05-07 14:57:32 +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
|
|
|
|
2019-05-07 14:57:32 +08:00
|
|
|
---
|
2016-07-26 11:03:44 +08:00
|
|
|
|
2016-09-09 13:55:21 +08:00
|
|
|
```jsx
|
|
|
|
|
import moment from 'moment';
|
2019-05-07 14:57:32 +08:00
|
|
|
<TimePicker defaultValue={moment('13:30:56', 'HH:mm:ss')} />;
|
2016-07-26 11:03:44 +08:00
|
|
|
```
|
|
|
|
|
|
2019-07-11 14:14:33 +08:00
|
|
|
| Property | Description | Type | Default | Version |
|
|
|
|
|
| --- | --- | --- | --- | --- |
|
2019-11-20 14:55:34 +08:00
|
|
|
| allowClear | allow clearing text | boolean | true | |
|
2019-07-11 14:14:33 +08:00
|
|
|
| autoFocus | get focus when component mounted | boolean | false | |
|
2020-02-06 10:02:02 +08:00
|
|
|
| bordered | whether has border style | boolean | true | |
|
2019-07-11 14:14:33 +08:00
|
|
|
| className | className of picker | string | '' | |
|
|
|
|
|
| clearText | clear tooltip of icon | string | clear | |
|
|
|
|
|
| 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 | |
|
|
|
|
|
| hourStep | interval between hours in picker | number | 1 | |
|
2019-11-20 14:55:34 +08:00
|
|
|
| inputReadOnly | Set the `readonly` attribute of the input tag (avoids virtual keyboard on touch devices) | boolean | false | |
|
2019-07-11 14:14:33 +08:00
|
|
|
| minuteStep | interval between minutes in picker | number | 1 | |
|
|
|
|
|
| open | whether to popup panel | boolean | false | |
|
|
|
|
|
| placeholder | display when there's no value | string | "Select a time" | |
|
2020-04-14 16:49:58 +08:00
|
|
|
| popupClassName | className of panel | string | - | |
|
2019-11-20 14:55:34 +08:00
|
|
|
| popupStyle | style of panel | object | - | |
|
2019-07-11 14:14:33 +08:00
|
|
|
| secondStep | interval between seconds in picker | number | 1 | |
|
2019-11-20 14:55:34 +08:00
|
|
|
| suffixIcon | The custom suffix icon | ReactNode | - | |
|
|
|
|
|
| clearIcon | The custom clear icon | ReactNode | - | |
|
2019-07-11 14:14:33 +08:00
|
|
|
| use12Hours | display as 12 hours format, with default format `h:mm:ss a` | boolean | false | |
|
2019-12-11 23:32:19 +08:00
|
|
|
| renderExtraFooter | called from time picker panel to render some addon to its bottom | () => ReactNode | - | |
|
2019-07-11 14:14:33 +08:00
|
|
|
| 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
|
|
|
|
2017-12-01 19:28:41 +08:00
|
|
|
## Methods
|
|
|
|
|
|
2019-07-11 14:14:33 +08:00
|
|
|
| Name | Description | Version |
|
|
|
|
|
| ------- | ------------ | ------- |
|
|
|
|
|
| blur() | remove focus | |
|
|
|
|
|
| focus() | get focus | |
|
2017-12-01 19:28:41 +08:00
|
|
|
|
2020-03-06 20:19:24 +08:00
|
|
|
### RangePicker
|
|
|
|
|
|
|
|
|
|
Same props from [RangePicker](/components/date-picker/#RangePicker) of DatePicker. And includes additional props:
|
|
|
|
|
|
|
|
|
|
| Property | Description | Type | Default | Version |
|
|
|
|
|
| -------- | ------------------------ | ------- | ------- | ------- |
|
|
|
|
|
| order | Order start and end time | boolean | true | 4.1.0 |
|
|
|
|
|
|
2019-12-11 23:32:19 +08:00
|
|
|
<style>.code-box-demo .ant-picker { margin: 0 8px 12px 0; }</style>
|
2020-01-02 16:05:59 +08:00
|
|
|
|
|
|
|
|
## FAQ
|
|
|
|
|
|
2020-01-08 11:29:37 +08:00
|
|
|
- [How to use TimePicker with customize date library like dayjs](/docs/react/replace-moment#TimePicker)
|
