CheckInput JAVASCRIPT UI Component API

CheckInput Javascript API

Class

CheckInput

CheckInput

CheckInput specifies an input field where the user can enter data. Auto-complete options with checkboxes are displayed for easier input. Checkboxes allow to select/unselect one or multiple items.

Selector

smart-check-input

Properties

AanimationSets or gets the animation mode. Animation is disabled when the property is set to 'none'
AautoCompleteDelayDetermines the delay before the drop down opens to show the matches from the auto complete operation. The delay is measured in miliseconds.
DdataSourceDetermines the data source that will be loaded to the Input. The dataSource can be an array of strings/numbers or objects where the attributes represent the properties of a List Item. For example label, value. It can also be a callback that returns an Array of items as previously described.
DdisabledEnables or disables the element.
DdropDownButtonPositionDetermines the position of the drop down button.
DdropDownHeightSets the height of the drop down. By default it's set to an empty string. In this case the height of the drop down is controlled by a CSS variable.
DdropDownWidthSets 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.
IinputPurposeSets 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.
IitemsDetermines the maximum number of matched items that should be visible inside the drop down as a result of a new autoComplete query. By default the maximum number of 8 items can be displayed inside the drop down.
LlocaleSets or gets the language. Used in conjunction with the property messages.
LlocalizeFormatFunctionCallback used to customize the format of the messages that are returned from the Localization Module.
MmessagesSets or gets an object specifying strings used in the widget that can be localized. Used in conjunction with the property locale.
MminLengthDetermines the minimum number of characters inside the input in order to trigger the autocomplete functionality that will open the drop down and show the matched items.
NnameSets or gets the name attribute for the element. Name is used when submiting data inside an HTML form.
OopenedDetermines whether the drop down is opened or not.
PplaceholderDetermines the placeholder of the input.
QquerySets or gets the query that is used to filter the items. Query is used by the autoComplete operation. Empty string means that all items from the data source will be displayed and no filter query is applied.
QqueryModeDetermines the auto complete query mode. This property also determines the matching algorithm for the autocomplete operation.
RreadonlyDetermines 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.
RrightToLeftSets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
SseparatorDetermines the delimiter between the selected items in the input.
SselectAllDetermines whether an additional item is displayed as the first item in the options list, which allows to select/unselect all items.
SselectedValuesGets or sets an array of selected values.
SsortedDetermines whether the items are sorted alphabetically or not
SsortDirectionDetermines the sorting algorithm - ascending(asc) or descending(desc) if sort is enabled.
TthemeDetermines the theme for the element. Themes define the look of the elements.
TtypeDetermines the input type. Input type determines what input can be entered.
UunfocusableIf is set to true, the element cannot be focused.
VvalueSets or gets the value of the element.

Events

CchangeThis event is triggered when the selection is changed.

Methods

CcloseCloses the drop down.
EensureVisibleEnsures that the active ( selected ) item is always visible.
OopenOpens the drop down.
SselectSelects the text inside the input or if it is readonly then the element is focused.

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-check-input animation='none'></smart-check-input>

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

 const checkinput = document.querySelector('smart-check-input');
 checkinput.animation = 'simple';

Get the animation property. 

 const checkinput = document.querySelector('smart-check-input');
 let animation = checkinput.animation;

autoCompleteDelaynumber

Determines the delay before the drop down opens to show the matches from the auto complete operation. The delay is measured in miliseconds.

Default value

100

Example

Set the autoCompleteDelay property. 

 <smart-check-input auto-complete-delay='50'></smart-check-input>

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

 const checkinput = document.querySelector('smart-check-input');
 checkinput.autoCompleteDelay = 200;

Get the autoCompleteDelay property. 

 const checkinput = document.querySelector('smart-check-input');
 let autoCompleteDelay = checkinput.autoCompleteDelay;

dataSourceany

Determines the data source that will be loaded to the Input. The dataSource can be an array of strings/numbers or objects where the attributes represent the properties of a List Item. For example label, value. It can also be a callback that returns an Array of items as previously described.

Try a demo showcasing the dataSource property.

Example

Set the dataSource property. 

 <smart-check-input data-source='[{ label: "item 1", value: 1 }, { label: "item 2", value: 2 }]'></smart-check-input>

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

 const checkinput = document.querySelector('smart-check-input');
 checkinput.dataSource = ["new item 1", "new item 2"];

Get the dataSource property. 

 const checkinput = document.querySelector('smart-check-input');
 let dataSource = checkinput.dataSource;

disabledboolean

Enables or disables the element.

Default value

false
Try a demo showcasing the disabled property.

Example

Set the disabled property. 

 <smart-check-input disabled></smart-check-input>

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

 const checkinput = document.querySelector('smart-check-input');
 checkinput.disabled = false;

Get the disabled property. 

 const checkinput = document.querySelector('smart-check-input');
 let disabled = checkinput.disabled;

dropDownButtonPosition"none" | "left" | "right" | "top" | "bottom"

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.
  • "top" - A drop down button is displayed on the top side of the element. The element acts as a DropDownList or a ComboBox depending on the readonly property.
  • "bottom" - A drop down button is displayed on the bottom 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. 

 <smart-check-input drop-down-button-position='top'></smart-check-input>

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

 const checkinput = document.querySelector('smart-check-input');
 checkinput.dropDownButtonPosition = 'bottom';

Get the dropDownButtonPosition property. 

 const checkinput = document.querySelector('smart-check-input');
 let dropDownButtonPosition = checkinput.dropDownButtonPosition;

dropDownHeightstring | number

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

Default value

""

Example

Set the dropDownHeight property. 

 <smart-check-input drop-down-height='300'></smart-check-input>

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

 const checkinput = document.querySelector('smart-check-input');
 checkinput.dropDownHeight = 500;

Get the dropDownHeight property. 

 const checkinput = document.querySelector('smart-check-input');
 let dropDownHeight = checkinput.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. 

 <smart-check-input drop-down-width='300'></smart-check-input>

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

 const checkinput = document.querySelector('smart-check-input');
 checkinput.dropDownWidth = 500;

Get the dropDownWidth property. 

 const checkinput = document.querySelector('smart-check-input');
 let dropDownWidth = checkinput.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. 

 <smart-check-input input-purpose='on'></smart-check-input>

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

 const checkinput = document.querySelector('smart-check-input');
 checkinput.inputPurpose = 'country';

Get the inputPurpose property. 

 const checkinput = document.querySelector('smart-check-input');
 let inputPurpose = checkinput.inputPurpose;

itemsnumber

Determines the maximum number of matched items that should be visible inside the drop down as a result of a new autoComplete query. By default the maximum number of 8 items can be displayed inside the drop down.

Default value

8

Example

Set the items property. 

 <smart-check-input items='2'></smart-check-input>

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

 const checkinput = document.querySelector('smart-check-input');
 checkinput.items = 5;

Get the items property. 

 const checkinput = document.querySelector('smart-check-input');
 let items = checkinput.items;

localestring

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

Default value

"en"

Example

Set the locale property. 

 <smart-check-input locale='de'></smart-check-input>

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

 const checkinput = document.querySelector('smart-check-input');
 checkinput.locale = 'en';

Get the locale property. 

 const checkinput = document.querySelector('smart-check-input');
 let locale = checkinput.locale;

localizeFormatFunctionfunction

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

Example

Set the localizeFormatFunction property. 

 <smart-check-input localize-format-function='function(defaultMessage, message, messageArguments){return '...'}'></smart-check-input>

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

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

Get the localizeFormatFunction property. 

 const checkinput = document.querySelector('smart-check-input');
 let localizeFormatFunction = checkinput.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. 

 <smart-check-input messages='{"de":{"propertyUnknownType":"Die Eigenschaft '{{name}}' hat ein nicht definiertes 'type'-Member!","propertyInvalidValue":"Ungultiger Eigenschaftswert '{{name}}'! Aktueller Wert: {{actualValue}}, Erwarteter Wert: {{value}}!","propertyInvalidValueType":"Ungultiger Eigenschaftswert '{{name}}'! Aktueller Wert: {{actualType}}, Erwarteter Wert: {{type}}!","elementNotInDOM":"Element existiert nicht in DOM! Bitte fugen Sie das Element zum DOM hinzu, bevor Sie eine Methode aufrufen.","moduleUndefined":"Modul ist nicht definiert.","missingReference":"{{elementType}}: Fehlender Verweis auf {{files}}.","htmlTemplateNotSuported":"{{elementType}}: Browser unterstutzt keine HTMLTemplate-Elemente.","invalidTemplate":"{{elementType}}: '{{property}}' Die Eigenschaft akzeptiert eine Zeichenfolge, die mit der ID eines HTMLTemplate-Elements aus dem DOM ubereinstimmen muss.","invalidNode":"{{elementType}}: Ungultiger Parameter '{{node}}' beim Aufruf von {{method}}."}}'></smart-check-input>

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

 const checkinput = document.querySelector('smart-check-input');
 checkinput.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 checkinput = document.querySelector('smart-check-input');
 let messages = checkinput.messages;

minLengthnumber

Determines the minimum number of characters inside the input in order to trigger the autocomplete functionality that will open the drop down and show the matched items.

Default value

1

Example

Set the minLength property. 

 <smart-check-input min-length='2'></smart-check-input>

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

 const checkinput = document.querySelector('smart-check-input');
 checkinput.minLength = 0;

Get the minLength property. 

 const checkinput = document.querySelector('smart-check-input');
 let minLength = checkinput.minLength;

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. 

 <smart-check-input name='dropdown'></smart-check-input>

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

 const checkinput = document.querySelector('smart-check-input');
 checkinput.name = 'dropDown2';

Get the name property. 

 const checkinput = document.querySelector('smart-check-input');
 let name = checkinput.name;

openedboolean

Determines whether the drop down is opened or not.

Default value

false

Example

Set the opened property. 

 <smart-check-input opened></smart-check-input>

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

 const checkinput = document.querySelector('smart-check-input');
 checkinput.opened = false;

Get the opened property. 

 const checkinput = document.querySelector('smart-check-input');
 let opened = checkinput.opened;

placeholderstring

Determines the placeholder of the input.

Default value

""
Try a demo showcasing the placeholder property.

Example

Set the placeholder property. 

 <smart-check-input placeholder='Empty'></smart-check-input>

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

 const checkinput = document.querySelector('smart-check-input');
 checkinput.placeholder = 'Enter:';

Get the placeholder property. 

 const checkinput = document.querySelector('smart-check-input');
 let placeholder = checkinput.placeholder;

querystring | number

Sets or gets the query that is used to filter the items. Query is used by the autoComplete operation. Empty string means that all items from the data source will be displayed and no filter query is applied.

Default value

""

Example

Set the query property. 

 <smart-check-input query='ABC'></smart-check-input>

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

 const checkinput = document.querySelector('smart-check-input');
 checkinput.query = 'some query';

Get the query property. 

 const checkinput = document.querySelector('smart-check-input');
 let query = checkinput.query;

queryMode"contains" | "containsIgnoreCase" | "doesNotContain" | "doesNotContainIgnoreCase" | "equals" | "equalsIgnoreCase" | "startsWith" | "startsWithIgnoreCase" | "endsWith" | "endsWithIgnoreCase"

Determines the auto complete query mode. This property also determines the matching algorithm for the autocomplete operation.

Allowed Values

  • "contains" - Displays the items that contain the search query (case sensitive)
  • "containsIgnoreCase" - Displays the items that contain the search query (case insensitive)
  • "doesNotContain" - Displays the items that do not contain the search query (case sensitive)
  • "doesNotContainIgnoreCase" - Displays the items that do not contain the search query (case insensitive)
  • "equals" - Displays the items that are equal the search query (case sensitive)
  • "equalsIgnoreCase" - Displays the items that are equal the search query (case insensitive)
  • "startsWith" - Displays the items that start with the search query (case sensitive)
  • "startsWithIgnoreCase" - Displays the items that start with the search query (case insensitive)
  • "endsWith" - Displays the items that end with the search query (case sensitive)
  • "endsWithIgnoreCase" - Displays the items that start with the search query (case insensitive)

Default value

"containsIgnoreCase"

Example

Set the queryMode property. 

 <smart-check-input query-mode='contains'></smart-check-input>

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

 const checkinput = document.querySelector('smart-check-input');
 checkinput.queryMode = 'endsWith';

Get the queryMode property. 

 const checkinput = document.querySelector('smart-check-input');
 let queryMode = checkinput.queryMode;

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. 

 <smart-check-input readonly></smart-check-input>

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

 const checkinput = document.querySelector('smart-check-input');
 checkinput.readonly = false;

Get the readonly property. 

 const checkinput = document.querySelector('smart-check-input');
 let readonly = checkinput.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. 

 <smart-check-input right-to-left></smart-check-input>

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

 const checkinput = document.querySelector('smart-check-input');
 checkinput.rightToLeft = true;

Get the rightToLeft property. 

 const checkinput = document.querySelector('smart-check-input');
 let rightToLeft = checkinput.rightToLeft;

separatorstring

Determines the delimiter between the selected items in the input.

Default value

","

Example

Set the separator property. 

 <smart-check-input separator='-'></smart-check-input>

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

 const checkinput = document.querySelector('smart-check-input');
 checkinput.separator = ',';

Get the separator property. 

 const checkinput = document.querySelector('smart-check-input');
 let separator = checkinput.separator;

selectAllboolean

Determines whether an additional item is displayed as the first item in the options list, which allows to select/unselect all items.

Default value

false

Example

Set the selectAll property. 

 <smart-check-input select-all></smart-check-input>

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

 const checkinput = document.querySelector('smart-check-input');
 checkinput.selectAll = false;

Get the selectAll property. 

 const checkinput = document.querySelector('smart-check-input');
 let selectAll = checkinput.selectAll;

selectedValuesarray

Gets or sets an array of selected values.

sortedboolean

Determines whether the items are sorted alphabetically or not

Default value

false

Example

Set the sorted property. 

 <smart-check-input sorted></smart-check-input>

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

 const checkinput = document.querySelector('smart-check-input');
 checkinput.sorted = false;

Get the sorted property. 

 const checkinput = document.querySelector('smart-check-input');
 let sorted = checkinput.sorted;

sortDirectionstring

Determines the sorting algorithm - ascending(asc) or descending(desc) if sort is enabled.

Default value

"asc"

Example

Set the sortDirection property. 

 <smart-check-input sort-direction='desc'></smart-check-input>

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

 const checkinput = document.querySelector('smart-check-input');
 checkinput.sortDirection = 'asc';

Get the sortDirection property. 

 const checkinput = document.querySelector('smart-check-input');
 let sortDirection = checkinput.sortDirection;

themestring

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

Default value

""

Example

Set the theme property. 

 <smart-check-input theme='blue'></smart-check-input>

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

 const checkinput = document.querySelector('smart-check-input');
 checkinput.theme = 'red';

Get the theme property. 

 const checkinput = document.querySelector('smart-check-input');
 let theme = checkinput.theme;

typestring

Determines the input type. Input type determines what input can be entered.

Default value

""

Example

Set the type property. 

 <smart-check-input type='blue'></smart-check-input>

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

 const checkinput = document.querySelector('smart-check-input');
 checkinput.type = 'red';

Get the type property. 

 const checkinput = document.querySelector('smart-check-input');
 let type = checkinput.type;

unfocusableboolean

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

Default value

false

Example

Set the unfocusable property. 

 <smart-check-input unfocusable></smart-check-input>

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

 const checkinput = document.querySelector('smart-check-input');
 checkinput.unfocusable = false;

Get the unfocusable property. 

 const checkinput = document.querySelector('smart-check-input');
 let unfocusable = checkinput.unfocusable;

valuestring

Sets or gets the value of the element.

Default value

""
Try a demo showcasing the value property.

Example

Set the value property. 

 <smart-check-input value='value1'></smart-check-input>

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

 const checkinput = document.querySelector('smart-check-input');
 checkinput.value = 'value2';

Get the value property. 

 const checkinput = document.querySelector('smart-check-input');
 let value = checkinput.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 checkinput = document.querySelector('smart-check-input');
checkinput.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 checkinput = document.querySelector('smart-check-input');
checkinput.close();

Try a demo showcasing the close method.

ensureVisible(): void

Ensures that the active ( selected ) item is always visible.


Invoke the ensureVisible method.

const checkinput = document.querySelector('smart-check-input');
checkinput.ensureVisible();

open(): void

Opens the drop down.


Invoke the open method.

const checkinput = document.querySelector('smart-check-input');
checkinput.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 checkinput = document.querySelector('smart-check-input');
checkinput.select();