Interface for a class TimePicker
EmitType<BlurEventArgs>
Triggers when the control loses the focus.
Triggers when the value is changed.
Triggers when timepicker value is cleared using clear button.
Triggers when the popup is closed.
EmitType<Object>
Triggers when the component is created.
EmitType<Object>
Triggers when the component is destroyed.
EmitType<FocusEventArgs>
Triggers when the control gets focused.
Triggers while rendering the each popup list item.
Triggers when the popup is opened.
boolean
Support for
allowEdit
has been provided fromv16.2.46
. Specifies whether the input textbox is editable or not. Here the user can select the value from the popup and cannot edit in the input textbox.
string
Specifies the root CSS class of the TimePicker that allows to customize the appearance by overriding the styles.
boolean
Specifies whether it is a masked timepicker or not. By default the timepicker component render without masked input. If you need masked timepicker input then specify it as true.
boolean
Enable or disable the persisting component’s state between the page reloads. If enabled, following list of states will be persisted.
boolean
Enable or disable rendering component in right to left direction.
boolean
Specifies whether the component to be disabled or not.
FloatLabelType
| string
Specifies the placeholder text to be floated. Possible values are: Never: The label will never float in the input when the placeholder is available. Always: The floating label will always float above the input. Auto: The floating label will float above the input after focusing or entering a value in the input.
string
| TimeFormatObject
Specifies the format of value that is to be displayed in component. By default, the format is based on the culture.
For more details refer to
Format
documentation.
<template>
<ejs-timepicker :format="format"></ejs-timepicker>
</template>
<script>
import Vue from "vue";
import { TimePickerPlugin } from "@syncfusion/ej2-vue-calendars";
Vue.use(TimePickerPlugin);
export default {
data() {
return {
format: { skeleton: 'medium' }
};
}
};
</script>
boolean
Specifies the component popup display full screen in mobile devices.
{ : }
You can add the additional html attributes such as disabled, value etc., to the element. If you configured both property and equivalent html attribute then the component considers the property value.
<template>
<ejs-timepicker :htmlAttributes="htmlAttributes"></ejs-timepicker>
</template>
<script>
import Vue from "vue";
import { TimePickerPlugin } from "@syncfusion/ej2-vue-calendars";
Vue.use(TimePickerPlugin);
export default {
data() {
return {
htmlAttributes: { name: "period", placeholder:"Select a time" }
};
}
};
</script>
{ : }
Customizes the key actions in TimePicker. For example, when using German keyboard, the key actions can be customized using these shortcuts.
Key action |
Key |
enter |
enter |
escape |
escape |
end |
end |
tab |
tab |
home |
home |
down |
downarrow |
up |
uparrow |
left |
leftarrow |
right |
rightarrow |
open |
alt+downarrow |
close |
alt+uparrow |
<template>
<ejs-timepicker :keyConfigs="keyConfigs"></ejs-timepicker>
</template>
<script>
import Vue from "vue";
import { TimePickerPlugin } from "@syncfusion/ej2-vue-calendars";
Vue.use(TimePickerPlugin);
export default {
data() {
return {
keyConfigs: {
enter: "space",
home: "ctrl+home",
end: "ctrl+end"
}
};
}
};
</script>
string
Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.
Specifies the mask placeholder to be displayed on masked timepicker.
Date
Gets or sets the maximum time value that can be allowed to select in TimePicker.
For more details refer to
Time Range
documentation.
Date
Gets or sets the minimum time value that can be allowed to select in TimePicker.
For more details refer to
Time Range
documentation.
boolean
By default, the popup opens while clicking on the timepicker icon. If you want to open the popup while focusing the time input then specify its value as true.
string
Specifies the placeholder text that is displayed in textbox.
boolean
Specifies the component in readonly state.
Date
Specifies the scroll bar position if there is no value is selected in the popup list or the given value is not present in the popup list.
For more details refer to
Time Duration
sample.
<template>
<ejs-timepicker :scrollTo="scrollTo"></ejs-timepicker>
</template>
<script>
import Vue from "vue";
import { TimePickerPlugin } from "@syncfusion/ej2-vue-calendars";
Vue.use(TimePickerPlugin);
export default {
data() {
return {
scrollTo: new Date("1/1/2018 5:30 PM")
};
}
};
</script>
number
By default, the time value will be processed based on system time zone.
If you want to process the initial time value using server time zone
then specify the time zone value to serverTimezoneOffset
property.
boolean
Specifies whether to show or hide the clear icon.
number
Specifies the time interval between the two adjacent time values in the popup list.
For more details refer to
Format
documentation.
boolean
Specifies the component to act as strict so that, it allows to enter only a valid time value within a specified range or else resets to previous value. By default, strictMode is in false.
For more details refer to
Strict Mode
documentation.
Date
Gets or sets the value of the component. The value is parsed based on the culture specific time format.
string
| number
Gets or sets the width of the TimePicker component. The width of the popup is based on the width of the component.
number
specifies the z-index value of the timePicker popup element.