ant-design/components/time-picker/index.en-US.md
2017-11-06 10:35:41 +08:00

2.3 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
addon called from timepicker panel to render some addon to its bottom function -
allowEmpty allow clearing text boolean true
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
open whether to popup panel boolean false
placeholder display when there's no value string "Select a time"
popupClassName className of panel string ''
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 -
hourStep interval between hours in picker number 1
minuteStep interval between minutes in picker number 1
secondStep interval between seconds in picker number 1