ant-design/components/time-picker/index.en-US.md
Wei Zhu 77b78a9389 docs: Unify type naming (#4636)
* Unify name of ReactNode type in document

* Lowser all string type name

* Lowercase all number type name

* Lowercase all boolean type name

* Unify array type

* Lowercase all object type name

* Unify mutilple types
2017-01-20 20:10:50 +08:00

1.7 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')} />

Note: TimePicker is renamed to TimePicker after 0.11.

Property Description Type Default
defaultValue to set default time moment -
value to set time moment -
placeholder display when there's no value string "Select a time"
onChange a callback function, can be executed when the selected time is changing function(time: moment, timeString: string): void -
format to set the time format string "HH:mm:ss"、"HH:mm"、"mm:ss"
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) -
hideDisabledOptions hide the options that can not be selected boolean false
getPopupContainer to set the container of the floating layer, while the default is to create a div element in body function(trigger) -
addon called from timepicker panel to render some addon to its bottom function