DateInput
DateInput specifies an input field where the user can enter a date. It also has a popup with a Calendar that allows to pick a date.
Selector
smart-date-input
Properties
Events
Methods
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-date-input animation='none'></smart-date-input>
Set the animation property by using the HTML Element's instance.
const dateinput = document.querySelector('smart-date-input');
dateinput.animation = 'simple';
Get the animation property.
const dateinput = document.querySelector('smart-date-input');
let animation = dateinput.animation;
autoCloseboolean
Determines whether the calendar button pop-up will be closed automatically when date or time is selected through it.
Default value
falseExample
Set the autoClose property.
<smart-date-input auto-close></smart-date-input>
Set the autoClose property by using the HTML Element's instance.
const dateinput = document.querySelector('smart-date-input');
dateinput.autoClose = false;
Get the autoClose property.
const dateinput = document.querySelector('smart-date-input');
let autoClose = dateinput.autoClose;
autoCloseDelaynumber
Determines the delay before the calendar pop-up is automatically closed. Applicable only when autoClose is set to true.
Default value
500Example
Set the autoCloseDelay property.
<smart-date-input auto-close-delay='0'></smart-date-input>
Set the autoCloseDelay property by using the HTML Element's instance.
const dateinput = document.querySelector('smart-date-input');
dateinput.autoCloseDelay = 100;
Get the autoCloseDelay property.
const dateinput = document.querySelector('smart-date-input');
let autoCloseDelay = dateinput.autoCloseDelay;
dateTimeFormatobject
Determines the format of the dates displayed in the input. Accepts valid ECMAScript Internationalization API format. Intl.DateTimeFormat is used to format date strings in JavaScript. By default the date format is 'numeric'. The default value is: { day: 'numeric', month: 'numeric', year: 'numeric' }
Default value
nullProperties
dateTimeFormat
day"numeric" | "2-digit"
Day format.
Default value
"numeric"month"numeric" | "2-digit" | "narrow" | "short" | "long"
Month format.
Default value
"numeric"year"numeric" | "2-digit"
Year format.
Default value
"numeric"Example
Set the dateTimeFormat property by using the HTML Element's instance.
const dateinput = document.querySelector('smart-date-input');
dateinput.dateTimeFormat.dateTimeFormat = { day: '2-digit', month: 'short' };
Get the dateTimeFormat property.
const dateinput = document.querySelector('smart-date-input');
let dateTimeFormat = dateinput.dateTimeFormat.dateTimeFormat;
disabledboolean
Enables or disables the element.
Default value
falseExample
Set the disabled property by using the HTML Element's instance.
const dateinput = document.querySelector('smart-date-input');
dateinput.dateTimeFormat.disabled = false;
Get the disabled property.
const dateinput = document.querySelector('smart-date-input');
let disabled = dateinput.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"Example
Set the dropDownButtonPosition property by using the HTML Element's instance.
const dateinput = document.querySelector('smart-date-input');
dateinput.dateTimeFormat.dropDownButtonPosition = 'right';
Get the dropDownButtonPosition property.
const dateinput = document.querySelector('smart-date-input');
let dropDownButtonPosition = dateinput.dateTimeFormat.dropDownButtonPosition;
dropDownHeightstring | number
Sets the height of the drop down. By default it's set to 'auto'.
Default value
autoExample
Set the dropDownHeight property by using the HTML Element's instance.
const dateinput = document.querySelector('smart-date-input');
dateinput.dateTimeFormat.dropDownHeight = 500;
Get the dropDownHeight property.
const dateinput = document.querySelector('smart-date-input');
let dropDownHeight = dateinput.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 dateinput = document.querySelector('smart-date-input');
dateinput.dateTimeFormat.dropDownWidth = 500;
Get the dropDownWidth property.
const dateinput = document.querySelector('smart-date-input');
let dropDownWidth = dateinput.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 dateinput = document.querySelector('smart-date-input');
dateinput.dateTimeFormat.inputPurpose = 'country';
Get the inputPurpose property.
const dateinput = document.querySelector('smart-date-input');
let inputPurpose = dateinput.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 dateinput = document.querySelector('smart-date-input');
dateinput.dateTimeFormat.locale = 'en';
Get the locale property.
const dateinput = document.querySelector('smart-date-input');
let locale = dateinput.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 dateinput = document.querySelector('smart-date-input');
dateinput.dateTimeFormat.localizeFormatFunction = function(defaultMessage, message, messageArguments){return '...'};
Get the localizeFormatFunction property.
const dateinput = document.querySelector('smart-date-input');
let localizeFormatFunction = dateinput.dateTimeFormat.localizeFormatFunction;
maxany
Determines the max date for the Calendar displayed inside the popup.
Default value
new Date(2100, 1, 1)Example
Set the max property by using the HTML Element's instance.
const dateinput = document.querySelector('smart-date-input');
dateinput.dateTimeFormat.max = new Date(2025, 0, 1);
Get the max property.
const dateinput = document.querySelector('smart-date-input');
let max = dateinput.dateTimeFormat.max;
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 dateinput = document.querySelector('smart-date-input');
dateinput.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 dateinput = document.querySelector('smart-date-input');
let messages = dateinput.dateTimeFormat.messages;
minany
Determines the min date for the Calendar displayed inside the popup.
Default value
new Date(1900, 1, 1)Example
Set the min property by using the HTML Element's instance.
const dateinput = document.querySelector('smart-date-input');
dateinput.dateTimeFormat.min = new Date(2000, 1, 2);
Get the min property.
const dateinput = document.querySelector('smart-date-input');
let min = dateinput.dateTimeFormat.min;
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 dateinput = document.querySelector('smart-date-input');
dateinput.dateTimeFormat.name = 'dropDown2';
Get the name property.
const dateinput = document.querySelector('smart-date-input');
let name = dateinput.dateTimeFormat.name;
openedboolean
Determines whether the drop down is opened or not.
Default value
falseExample
Set the opened property by using the HTML Element's instance.
const dateinput = document.querySelector('smart-date-input');
dateinput.dateTimeFormat.opened = false;
Get the opened property.
const dateinput = document.querySelector('smart-date-input');
let opened = dateinput.dateTimeFormat.opened;
placeholderstring
Determines the placeholder of the input.
Default value
""Example
Set the placeholder property by using the HTML Element's instance.
const dateinput = document.querySelector('smart-date-input');
dateinput.dateTimeFormat.placeholder = 'Enter:';
Get the placeholder property.
const dateinput = document.querySelector('smart-date-input');
let placeholder = dateinput.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
falseExample
Set the readonly property by using the HTML Element's instance.
const dateinput = document.querySelector('smart-date-input');
dateinput.dateTimeFormat.readonly = false;
Get the readonly property.
const dateinput = document.querySelector('smart-date-input');
let readonly = dateinput.dateTimeFormat.readonly;
rightToLeftboolean
Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
Default value
falseExample
Set the rightToLeft property by using the HTML Element's instance.
const dateinput = document.querySelector('smart-date-input');
dateinput.dateTimeFormat.rightToLeft = true;
Get the rightToLeft property.
const dateinput = document.querySelector('smart-date-input');
let rightToLeft = dateinput.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 dateinput = document.querySelector('smart-date-input');
dateinput.dateTimeFormat.theme = 'red';
Get the theme property.
const dateinput = document.querySelector('smart-date-input');
let theme = dateinput.dateTimeFormat.theme;
unfocusableboolean
If is set to true, the element cannot be focused.
Default value
falseExample
Set the unfocusable property by using the HTML Element's instance.
const dateinput = document.querySelector('smart-date-input');
dateinput.dateTimeFormat.unfocusable = false;
Get the unfocusable property.
const dateinput = document.querySelector('smart-date-input');
let unfocusable = dateinput.dateTimeFormat.unfocusable;
valueany
Sets or gets the value of the element. Expected value is: Date string, Date object or null.
Default value
""Example
Set the value property by using the HTML Element's instance.
const dateinput = document.querySelector('smart-date-input');
dateinput.dateTimeFormat.value = 9/15/2020;
Get the value property.
const dateinput = document.querySelector('smart-date-input');
let value = dateinput.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 dateinput = document.querySelector('smart-date-input'); dateinput.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 dateinput = document.querySelector('smart-date-input'); dateinput.close();
Try a demo showcasing the close method.
open(): void
Opens the drop down.
Invoke the open method.
const dateinput = document.querySelector('smart-date-input'); dateinput.open();
Try a demo showcasing the open method.
select(): void
Selects the text inside the input or if it is readonly then the element is focused.
Invoke the select method.
const dateinput = document.querySelector('smart-date-input'); dateinput.select();
getFormattedValue( value: string | Date, format?: any): void
Returns the value in the desired format.
Arguments
valuestring | Date
The value to be formatted by the method.
format?any
The object that contains the formatting properties. The argument should contain Intl.DateTimeFormat valid properties.
Invoke the getFormattedValue method.
const dateinput = document.querySelector('smart-date-input'); dateinput.getFormattedValue();
getValue(): void
Returns the date of the input.
Invoke the getValue method.
const dateinput = document.querySelector('smart-date-input'); dateinput.getValue();
setValue( value: string | Date): void
Sets the date of the input.
Arguments
valuestring | Date
The value to be set.
Invoke the setValue method.
const dateinput = document.querySelector('smart-date-input'); dateinput.setValue();