2021-10-22 19:32:39 +08:00
---
2021-10-25 15:21:08 +08:00
title: TimePicker
2021-10-22 19:32:39 +08:00
lang: en-US
---
2021-09-17 00:18:50 +08:00
# TimePicker
2020-08-13 15:18:26 +08:00
Use Time Picker for time input.
2021-09-17 00:18:50 +08:00
## Arbitrary time picker
2020-08-13 15:18:26 +08:00
Can pick an arbitrary time.
2022-01-12 08:43:21 +08:00
:::demo By default, you can scroll the mouse wheel to pick time, alternatively you can use the control arrows when the `arrow-control` attribute is set.
2020-08-13 15:18:26 +08:00
2021-09-17 00:18:50 +08:00
time-picker/basic
2021-09-04 19:29:28 +08:00
2020-08-13 15:18:26 +08:00
:::
2022-01-12 08:43:21 +08:00
## Limit the time range
You can also limit the time range.
:::demo Limit the time range by specifying `disabledHours` `disabledMinutes` and `disabledSeconds` .
time-picker/basic-range
:::
2021-09-17 00:18:50 +08:00
## Arbitrary time range
2020-08-13 15:18:26 +08:00
Can pick an arbitrary time range.
:::demo We can pick a time range by adding an `is-range` attribute. Also, `arrow-control` is supported in range mode.
2021-09-04 19:29:28 +08:00
2021-09-17 00:18:50 +08:00
time-picker/range
2021-09-04 19:29:28 +08:00
2020-08-13 15:18:26 +08:00
:::
2021-09-17 00:18:50 +08:00
## Attributes
2021-09-04 19:29:28 +08:00
2021-12-27 16:04:39 +08:00
| Attribute | Description | Type | Accepted Values | Default |
| --------------------- | ------------------------------------------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------- | ----------- |
| model-value / v-model | binding value | Date | — | — |
| readonly | whether TimePicker is read only | boolean | — | false |
| disabled | whether TimePicker is disabled | boolean | — | false |
| editable | whether the input is editable | boolean | — | true |
| clearable | whether to show clear button | boolean | — | true |
| size | size of Input | string | large / default / small | — |
| placeholder | placeholder in non-range mode | string | — | — |
| start-placeholder | placeholder for the start time in range mode | string | — | — |
| end-placeholder | placeholder for the end time in range mode | string | — | — |
| is-range | whether to pick a time range | boolean | — | false |
| arrow-control | whether to pick time using arrow buttons | boolean | — | false |
| popper-class | custom class name for TimePicker's dropdown | string | — | — |
| range-separator | range separator | string | — | '-' |
| format | format of the displayed value in the input box | string | see [date formats ](/en-US/component/date-picker#date-formats ) | HH:mm:ss |
| default-value | optional, default date of the calendar | Date for TimePicker, string for TimeSelect | anything accepted by `new Date()` for TimePicker, selectable value for TimeSelect | — |
| id | same as `id` in native input | string / array(string) | String `id="my-time"` or array `:id="['my-range-start', 'my-range-end']"` for range | - |
| name | same as `name` in native input | string | — | — |
| prefix-icon | Custom prefix icon component | string / Component | — | Clock |
| clear-icon | Custom clear icon component | string / Component | — | CircleClose |
| disabled-hours | To specify the array of hours that cannot be selected | function | — | — |
| disabled-minutes | To specify the array of minutes that cannot be selected | function(selectedHour) | — | — |
| disabled-seconds | To specify the array of seconds that cannot be selected | function(selectedHour, selectedMinute) | — | — |
2022-02-21 10:16:42 +08:00
| teleported | whether time-picker dropdown is teleported to the body | boolean | true / false | true |
2020-08-13 15:18:26 +08:00
2021-09-17 00:18:50 +08:00
## Events
2021-09-04 19:29:28 +08:00
2022-05-31 10:03:44 +08:00
| Event Name | Description | Parameters |
| -------------- | ---------------------------------------------------------- | ----------------------- |
| change | triggers when user confirms the value | `(val: typeof v-model)` |
| blur | triggers when Input blurs | `(e: FocusEvent)` |
| focus | triggers when Input focuses | `(e: FocusEvent)` |
| visible-change | triggers when the TimePicker's dropdown appears/disappears | `(visibility: boolean)` |
2020-08-13 15:18:26 +08:00
2021-09-17 00:18:50 +08:00
## Methods
2021-09-04 19:29:28 +08:00
| Method | Description | Parameters |
| ------ | ------------------------- | ---------- |
| focus | focus the Input component | — |
| blur | blur the Input component | — |
