mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-11 13:59:11 +08:00
fb0b4f0fc9
* docs: add api first appearance * docs: fix auto-complete doc * docs: replace Version Added with Version * docs: date picker common method * docs: date picker common method * docs: tree * docs: remove meaningless 3.0.0
2.9 KiB
2.9 KiB
| category | type | title |
|---|---|---|
| Components | Data Entry | TimePicker |
To select/input a time.
When To Use
By clicking the input box, you can select a time from a popup panel.
API
import moment from 'moment';
<TimePicker defaultValue={moment('13:30:56', 'HH:mm:ss')} />;
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
| addon | called from timepicker panel to render some addon to its bottom | function | - | |
| allowClear | allow clearing text | boolean | true | 3.13.0 |
| autoFocus | get focus when component mounted | boolean | false | |
| className | className of picker | string | '' | |
| clearText | clear tooltip of icon | string | clear | |
| defaultOpenValue | default open panel value, used to set utcOffset,locale if value/defaultValue absent | moment | moment() | |
| defaultValue | to set default time | moment | - | |
| 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 | |
| inputReadOnly | Set the readonly attribute of the input tag (avoids virtual keyboard on touch devices) |
boolean | false | 3.3.0 |
| 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" | |
| popupClassName | className of panel | string | '' | |
| popupStyle | style of panel | object | - | 3.12.0 |
| secondStep | interval between seconds in picker | number | 1 | |
| suffixIcon | The custom suffix icon | ReactNode | - | 3.10.0 |
| clearIcon | The custom clear icon | ReactNode | - | 3.14.0 |
| use12Hours | display as 12 hours format, with default format h:mm:ss a |
boolean | false | |
| value | to set time | moment | - | |
| 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 | - |
Methods
| Name | Description | Version |
|---|---|---|
| blur() | remove focus | |
| focus() | get focus |