TimeInput JAVASCRIPT UI Component API

TimeInput Javascript API

Class

TimeInput
dateTimeFormat

TimeInput

TimeInput specifies an input field where the user can enter a time. It also has a popup with a Calendar that allows to pick a time.

Selector

smart-time-input

Properties

AanimationSets or gets the animation mode. Animation is disabled when the property is set to 'none'
DdateTimeFormatDetermines the format of the time displayed in the input. Accepts valid ECMAScript Internationalization API format. By default the date format is 'numeric'.
HhourHour format.
MminuteMinute format.

Events

CchangeThis event is triggered when the selection is changed.

Methods

CcloseCloses the drop down.
OopenOpens the drop down.
GgetFormattedValueReturns the value in the desired format.
GgetValueReturns the value of the input.
SselectSelects the text inside the input or if it is readonly then the element is focused.
SsetValueSets the value of the input. Expects an array of 2 numbers for hours and minutes.

Properties

animation"none" | "simple" | "advanced"

Sets or gets the animation mode. Animation is disabled when the property is set to 'none'

Allowed Values

  • "none" - animation is disabled
  • "simple" - ripple animation is disabled
  • "advanced" - all animations are enabled

Default value

"advanced"

Example

Set the animation property. 

 <smart-time-input animation='none'></smart-time-input>

Set the animation property by using the HTML Element's instance. 

 const timeinput = document.querySelector('smart-time-input');
 timeinput.animation = 'simple';

Get the animation property. 

 const timeinput = document.querySelector('smart-time-input');
 let animation = timeinput.animation;

dateTimeFormatobject

Determines the format of the time displayed in the input. Accepts valid ECMAScript Internationalization API format. By default the date format is 'numeric'.

Default value

null

Properties

dateTimeFormat

hour"numeric" | "2-digit"

Hour format.

Default value

"2-digit"

minute"numeric" | "2-digit"

Minute format.

Default value

"2-digit"

Example

Set the dateTimeFormat property by using the HTML Element's instance. 

 const timeinput = document.querySelector('smart-time-input');
 timeinput.dateTimeFormat.dateTimeFormat = { hour: 'numeric', minute: 'numeric' };

Get the dateTimeFormat property. 

 const timeinput = document.querySelector('smart-time-input');
 let dateTimeFormat = timeinput.dateTimeFormat.dateTimeFormat;

disabledboolean

Enables or disables the element.

Default value

false
Try a demo showcasing the disabled property.

Example

Set the disabled property by using the HTML Element's instance. 

 const timeinput = document.querySelector('smart-time-input');
 timeinput.dateTimeFormat.disabled = false;

Get the disabled property. 

 const timeinput = document.querySelector('smart-time-input');
 let disabled = timeinput.dateTimeFormat.disabled;

dropDownButtonPosition"none" | "left" | "right"

Determines the position of the drop down button.

Allowed Values

  • "none" - The drop down button is hidden and the element acts as a simple input.
  • "left" - A drop down button is displayed on the left side of the element. The element acts as a DropDownList or a ComboBox depending on the readonly property.
  • "right" - A drop down button is displayed on the right side of the element. The element acts as a DropDownList or a ComboBox depending on the readonly property.

Default value

"right"
Try a demo showcasing the dropDownButtonPosition property.

Example

Set the dropDownButtonPosition property by using the HTML Element's instance. 

 const timeinput = document.querySelector('smart-time-input');
 timeinput.dateTimeFormat.dropDownButtonPosition = 'right';

Get the dropDownButtonPosition property. 

 const timeinput = document.querySelector('smart-time-input');
 let dropDownButtonPosition = timeinput.dateTimeFormat.dropDownButtonPosition;

dropDownHeightstring | number

Sets the height of the drop down. By default it's set to 'auto'.

Default value

auto

Example

Set the dropDownHeight property by using the HTML Element's instance. 

 const timeinput = document.querySelector('smart-time-input');
 timeinput.dateTimeFormat.dropDownHeight = 500;

Get the dropDownHeight property. 

 const timeinput = document.querySelector('smart-time-input');
 let dropDownHeight = timeinput.dateTimeFormat.dropDownHeight;

dropDownWidthstring | number

Sets the width of the drop down. By default it's set to an empty string. In this case the width of the drop down is controlled by a CSS variable.

Default value

""

Example

Set the dropDownWidth property by using the HTML Element's instance. 

 const timeinput = document.querySelector('smart-time-input');
 timeinput.dateTimeFormat.dropDownWidth = 500;

Get the dropDownWidth property. 

 const timeinput = document.querySelector('smart-time-input');
 let dropDownWidth = timeinput.dateTimeFormat.dropDownWidth;

inputPurposestring

Sets the purpose of the input and what, if any, permission the user agent has to provide automated assistance in filling out the element's input when in a form, as well as guidance to the browser as to the type of information expected in the element. This value corresponds to the standard HTML autocomplete attribute and can be set to values such as 'on', 'name', 'organization', 'street-address', etc.

Default value

"off"

Example

Set the inputPurpose property by using the HTML Element's instance. 

 const timeinput = document.querySelector('smart-time-input');
 timeinput.dateTimeFormat.inputPurpose = 'country';

Get the inputPurpose property. 

 const timeinput = document.querySelector('smart-time-input');
 let inputPurpose = timeinput.dateTimeFormat.inputPurpose;

localestring

Sets or gets the language. Used in conjunction with the property messages.

Default value

"en"

Example

Set the locale property by using the HTML Element's instance. 

 const timeinput = document.querySelector('smart-time-input');
 timeinput.dateTimeFormat.locale = 'en';

Get the locale property. 

 const timeinput = document.querySelector('smart-time-input');
 let locale = timeinput.dateTimeFormat.locale;

localizeFormatFunctionfunction

Callback used to customize the format of the messages that are returned from the Localization Module.

Example

Set the localizeFormatFunction property by using the HTML Element's instance. 

 const timeinput = document.querySelector('smart-time-input');
 timeinput.dateTimeFormat.localizeFormatFunction = function(defaultMessage, message, messageArguments){return '...'};

Get the localizeFormatFunction property. 

 const timeinput = document.querySelector('smart-time-input');
 let localizeFormatFunction = timeinput.dateTimeFormat.localizeFormatFunction;

messagesobject

Sets or gets an object specifying strings used in the widget that can be localized. Used in conjunction with the property locale.

Default value




"en": {

"propertyUnknownType": "'{{name}}' property is with undefined 'type' member!",

"propertyInvalidValue": "Invalid '{{name}}' property value! Actual value: {{actualValue}}, Expected value: {{value}}!",

"propertyInvalidValueType": "Invalid '{{name}}' property value type! Actual type: {{actualType}}, Expected type: {{type}}!",

"elementNotInDOM": "Element does not exist in DOM! Please, add the element to the DOM, before invoking a method.",

"moduleUndefined": "Module is undefined.",

"missingReference": "{{elementType}}: Missing reference to {{files}}.",

"htmlTemplateNotSuported": "{{elementType}}: Browser doesn't support HTMLTemplate elements.",

"invalidTemplate": "{{elementType}}: '{{property}}' property accepts a string that must match the id of an HTMLTemplate element from the DOM.",

"invalidNode": "{{elementType}}: Invalid parameter '{{node}}' when calling {{method}}."

}

Example

Set the messages property by using the HTML Element's instance. 

 const timeinput = document.querySelector('smart-time-input');
 timeinput.dateTimeFormat.messages = {"en":{"propertyUnknownType":"'{{name}}' property is with undefined 'type' member!","propertyInvalidValue":"Invalid '{{name}}' property value! Actual value: {{actualValue}}, Expected value: {{value}}!","propertyInvalidValueType":"Invalid '{{name}}' property value type! Actual type: {{actualType}}, Expected type: {{type}}!","elementNotInDOM":"Element does not exist in DOM! Please, add the element to the DOM, before invoking a method.","moduleUndefined":"Module is undefined.","missingReference":"{{elementType}}: Missing reference to {{files}}.","htmlTemplateNotSuported":"{{elementType}}: Browser doesn't support HTMLTemplate elements.","invalidTemplate":"{{elementType}}: '{{property}}' property accepts a string that must match the id of an HTMLTemplate element from the DOM.","invalidNode":"{{elementType}}: Invalid parameter '{{node}}' when calling {{method}}."}};

Get the messages property. 

 const timeinput = document.querySelector('smart-time-input');
 let messages = timeinput.dateTimeFormat.messages;

namestring

Sets or gets the name attribute for the element. Name is used when submiting data inside an HTML form.

Default value

""

Example

Set the name property by using the HTML Element's instance. 

 const timeinput = document.querySelector('smart-time-input');
 timeinput.dateTimeFormat.name = 'dropDown2';

Get the name property. 

 const timeinput = document.querySelector('smart-time-input');
 let name = timeinput.dateTimeFormat.name;

openedboolean

Determines whether the drop down is opened or not.

Default value

false

Example

Set the opened property by using the HTML Element's instance. 

 const timeinput = document.querySelector('smart-time-input');
 timeinput.dateTimeFormat.opened = false;

Get the opened property. 

 const timeinput = document.querySelector('smart-time-input');
 let opened = timeinput.dateTimeFormat.opened;

placeholderstring

Determines the placeholder of the input.

Default value

""
Try a demo showcasing the placeholder property.

Example

Set the placeholder property by using the HTML Element's instance. 

 const timeinput = document.querySelector('smart-time-input');
 timeinput.dateTimeFormat.placeholder = 'Enter:';

Get the placeholder property. 

 const timeinput = document.querySelector('smart-time-input');
 let placeholder = timeinput.dateTimeFormat.placeholder;

readonlyboolean

Determines whether ot not the user can enter text inside the input. if dropDownButtonPosition is set to 'left' or 'right' then readonly determines whether the element acts as a ComboBox or a DropDownList if a dataSource is provided.

Default value

false
Try a demo showcasing the readonly property.

Example

Set the readonly property by using the HTML Element's instance. 

 const timeinput = document.querySelector('smart-time-input');
 timeinput.dateTimeFormat.readonly = false;

Get the readonly property. 

 const timeinput = document.querySelector('smart-time-input');
 let readonly = timeinput.dateTimeFormat.readonly;

rightToLeftboolean

Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.

Default value

false
Try a demo showcasing the rightToLeft property.

Example

Set the rightToLeft property by using the HTML Element's instance. 

 const timeinput = document.querySelector('smart-time-input');
 timeinput.dateTimeFormat.rightToLeft = true;

Get the rightToLeft property. 

 const timeinput = document.querySelector('smart-time-input');
 let rightToLeft = timeinput.dateTimeFormat.rightToLeft;

themestring

Determines the theme for the element. Themes define the look of the elements.

Default value

""

Example

Set the theme property by using the HTML Element's instance. 

 const timeinput = document.querySelector('smart-time-input');
 timeinput.dateTimeFormat.theme = 'red';

Get the theme property. 

 const timeinput = document.querySelector('smart-time-input');
 let theme = timeinput.dateTimeFormat.theme;

unfocusableboolean

If is set to true, the element cannot be focused.

Default value

false

Example

Set the unfocusable property by using the HTML Element's instance. 

 const timeinput = document.querySelector('smart-time-input');
 timeinput.dateTimeFormat.unfocusable = false;

Get the unfocusable property. 

 const timeinput = document.querySelector('smart-time-input');
 let unfocusable = timeinput.dateTimeFormat.unfocusable;

valueany

Sets or gets the value of the element.

Default value

""

Example

Set the value property by using the HTML Element's instance. 

 const timeinput = document.querySelector('smart-time-input');
 timeinput.dateTimeFormat.value = 16:30;

Get the value property. 

 const timeinput = document.querySelector('smart-time-input');
 let value = timeinput.dateTimeFormat.value;

Events

changeCustomEvent

This event is triggered when the selection is changed.

  • Bubbles Yes
  • Cancelable No
  • Interface CustomEvent
  • Event handler property onChange

Arguments

evCustomEvent
ev.detailObject
ev.detail.label - The label of the new selected item.
ev.detail.oldLabel - The label of the item that was previously selected before the event was triggered.
ev.detail.oldValue - The value of the item that was previously selected before the event was triggered.
ev.detail.value - The value of the new selected item.

Methods

isDefaultPrevented

Returns true if the event was prevented by any of its subscribers.

Returns

boolean true if the default action was prevented. Otherwise, returns false.

preventDefault

The preventDefault() method prevents the default action for a specified event. In this way, the source component suppresses the built-in behavior that follows the event.

stopPropagation

The stopPropagation() method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.

Example

Set up the event handler of change event. 

const timeinput = document.querySelector('smart-time-input');
timeinput.addEventListener('change', function (event) {
    const detail = event.detail,
        label = detail.label,
        oldLabel = detail.oldLabel,
        oldValue = detail.oldValue,
        value = detail.value;

	// event handling code goes here.
})

Methods

close(): void

Closes the drop down.


Invoke the close method.

const timeinput = document.querySelector('smart-time-input');
timeinput.close();

Try a demo showcasing the close method.

open(): void

Opens the drop down.


Invoke the open method.

const timeinput = document.querySelector('smart-time-input');
timeinput.open();

Try a demo showcasing the open method.

getFormattedValue(): void

Returns the value in the desired format.


Invoke the getFormattedValue method.

const timeinput = document.querySelector('smart-time-input');
timeinput.getFormattedValue();

getValue(): void

Returns the value of the input.


Invoke the getValue method.

const timeinput = document.querySelector('smart-time-input');
timeinput.getValue();

select(): void

Selects the text inside the input or if it is readonly then the element is focused.


Invoke the select method.

const timeinput = document.querySelector('smart-time-input');
timeinput.select();

setValue( value: any[]): void

Sets the value of the input. Expects an array of 2 numbers for hours and minutes.

Arguments

valueany[]

The value to be set.


Invoke the setValue method.

const timeinput = document.querySelector('smart-time-input');
timeinput.setValue();