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

106 lines
4.3 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
cover: https://gw.alipayobjects.com/zos/alicdn/h04Zsl98I/TimePicker.svg
2016-07-26 11:03:44 +08:00
---
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
```jsx
import moment from 'moment';
2020-04-28 14:09:54 +08:00
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
```
| Property | Description | Type | Default | Version |
| --- | --- | --- | --- | --- |
| allowClear | Whether allow clearing text | boolean | true | |
| autoFocus | If get focus when component mounted | boolean | false | |
| bordered | Whether has border style | boolean | true | |
| className | The className of picker | string | - | |
| clearIcon | The custom clear icon | ReactNode | - | |
| clearText | The clear tooltip of icon | string | clear | |
| defaultValue | To set default time | [moment](http://momentjs.com/) | - | |
| disabled | Determine whether the TimePicker is disabled | boolean | false | |
| disabledTime | To specify the time that cannot be selected | [DisabledTime](#DisabledTime) | - | 4.19.0 |
| 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 | Whether hide the options that can not be selected | boolean | false | |
| hourStep | Interval between hours in picker | number | 1 | |
| inputReadOnly | Set the `readonly` attribute of the input tag (avoids virtual keyboard on touch devices) | boolean | false | |
| minuteStep | Interval between minutes in picker | number | 1 | |
| open | Whether to popup panel | boolean | false | |
| placeholder | Display when there's no value | string \| \[string, string] | `Select a time` | |
| placement | The position where the selection box pops up | `bottomLeft` `bottomRight` `topLeft` `topRight` | bottomLeft | |
| popupClassName | The className of panel | string | - | |
| popupStyle | The style of panel | CSSProperties | - | |
| renderExtraFooter | Called from time picker panel to render some addon to its bottom | () => ReactNode | - | |
| secondStep | Interval between seconds in picker | number | 1 | |
| showNow | Whether to show `Now` button on panel | boolean | - | 4.4.0 |
| status | Set validation status | 'error' \| 'warning' \| 'success' \| 'validating' | - | 4.19.0 |
| suffixIcon | The custom suffix icon | ReactNode | - | |
| 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 | - | |
| onSelect | A callback function, executes when a value is selected | function(time: moment): void | - | |
2016-07-26 11:03:44 +08:00
#### DisabledTime
```typescript
type DisabledTime = (now: Moment) => {
disabledHours?: () => number[];
disabledMinutes?: (selectedHour: number) => number[];
disabledSeconds?: (selectedHour: number, selectedMinute: number) => number[];
};
```
## Methods
| Name | Description | Version |
| ------- | ------------ | ------- |
| blur() | Remove focus | |
| focus() | Get focus | |
### RangePicker
Same props from [RangePicker](/components/date-picker/#RangePicker) of DatePicker. And includes additional props:
2021-03-01 19:20:48 +08:00
| Property | Description | Type | Default | Version |
| --- | --- | --- | --- | --- |
| disabledTime | To specify the time that cannot be selected | [RangeDisabledTime](#RangeDisabledTime) | - | 4.19.0 |
2021-03-01 19:20:48 +08:00
| order | Order start and end time | boolean | true | 4.1.0 |
### RangeDisabledTime
```typescript
type RangeDisabledTime = (
now: Moment,
type = 'start' | 'end',
) => {
disabledHours?: () => number[];
disabledMinutes?: (selectedHour: number) => number[];
disabledSeconds?: (selectedHour: number, selectedMinute: number) => number[];
};
```
2020-05-10 22:11:09 +08:00
<style>
.code-box-demo .ant-picker { margin: 0 8px 12px 0; }
.ant-row-rtl .code-box-demo .ant-picker { margin: 0 0 12px 8px; }
</style>
## FAQ
- [How to use TimePicker with customize date library like dayjs](/docs/react/replace-moment#TimePicker)