Back to Element Plus

TimeSelect

docs/en-US/component/time-select.md

2.13.77.3 KB
Original Source

TimeSelect

Use Time Select for time input.

The available time range is 00:00 to 23:59

Fixed time picker

Provide a list of fixed time for users to choose.

:::demo Use el-time-select label, then assign start time, end time and time step with start, end and step.

time-select/basic

:::

Time Formats

Use format to control format of time(hours and minutes).

Check the list here of all available formats of Day.js.

:::warning

Pay attention to capitalization

:::

:::demo

time-select/time-formats

:::

Fixed time range

If start( end ) time is picked at first, then the status of end( start ) time's options will change accordingly.

:::demo

time-select/time-range

:::

API

Attributes

NameDescriptionTypeDefault
model-value / v-modelbinding value^[string]
disabledwhether TimeSelect is disabled^[boolean]false
editablewhether the input is editable^[boolean]true
clearablewhether to show clear button^[boolean]true
include-end-time ^(2.9.3)whether end is included in options^[boolean]false
sizesize of Input^[enum]'large' | 'default' | 'small'default
placeholderplaceholder in non-range mode^[string]
name ^(2.13.3)same as name in native input^[string]
effectTooltip theme, built-in theme: dark / light^[string] / ^[enum]'dark' | 'light'light
prefix-iconcustom prefix icon component^[string] / ^[Component]Clock
clear-iconcustom clear icon component^[string] / ^[Component]CircleClose
startstart time^[string]09:00
endend time^[string]18:00
steptime step^[string]00:30
min-timeminimum time, any time before this time will be disabled^[string]
max-timemaximum time, any time after this time will be disabled^[string]
formatset format of time^[string] see formatsHH:mm
empty-values ^(2.7.0)empty values of component, see config-provider^[array]
value-on-clear ^(2.7.0)clear return value, see config-provider^[string] / ^[number] / ^[boolean] / ^[Function]
popper-class ^(2.11.4)custom class name for TimeSelect's dropdown^[string]''
popper-style ^(2.11.4)custom style for TimeSelect's dropdown^[string] / ^[object]

Events

NameDescriptionType
changetriggers when user confirms the value^[Function](value: string) => void
blurtriggers when Input blurs^[Function](event: FocusEvent) => void
focustriggers when Input focuses^[Function](event: FocusEvent) => void
clear ^(2.7.7)triggers when the clear icon is clicked in a clearable TimeSelect^[Function]() => void

Exposes

MethodDescriptionType
focusfocus the Input component^[Function]() => void
blurblur the Input component^[Function]() => void