MultiInput JAVASCRIPT UI Component API

MultiInput Javascript API

Class

MultiInput

MultiInput specifies an input field where the user can enter data. Auto-complete options are displayed for easier input. Allows multiple selection. Selected items are added to the input's value.

Selector

smart-multi-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'

Default value

"advanced"

Example

Set the animation property.

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

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

 const multiinput = document.querySelector('smart-multi-input');
 multiinput.animation = 'simple';

Get the animation property.

 const multiinput = document.querySelector('smart-multi-input');
 let animation = multiinput.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-multi-input auto-complete-delay='50'></smart-multi-input>

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

 const multiinput = document.querySelector('smart-multi-input');
 multiinput.autoCompleteDelay = 200;

Get the autoCompleteDelay property.

 const multiinput = document.querySelector('smart-multi-input');
 let autoCompleteDelay = multiinput.autoCompleteDelay;

dataSourceany

Determines the data source that will be loaded to the MutliInput. 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.

Example

Set the dataSource property.

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

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

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

Get the dataSource property.

 const multiinput = document.querySelector('smart-multi-input');
 let dataSource = multiinput.dataSource;

disabledboolean

Enables or disables the element.

Default value

false

Example

Set the disabled property.

 <smart-multi-input disabled></smart-multi-input>

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

 const multiinput = document.querySelector('smart-multi-input');
 multiinput.disabled = false;

Get the disabled property.

 const multiinput = document.querySelector('smart-multi-input');
 let disabled = multiinput.disabled;

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

Determines the position of the drop down button.

Default value

"right"

Example

Set the dropDownButtonPosition property.

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

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

 const multiinput = document.querySelector('smart-multi-input');
 multiinput.dropDownButtonPosition = 'bottom';

Get the dropDownButtonPosition property.

 const multiinput = document.querySelector('smart-multi-input');
 let dropDownButtonPosition = multiinput.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-multi-input drop-down-height='300'></smart-multi-input>

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

 const multiinput = document.querySelector('smart-multi-input');
 multiinput.dropDownHeight = 500;

Get the dropDownHeight property.

 const multiinput = document.querySelector('smart-multi-input');
 let dropDownHeight = multiinput.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-multi-input drop-down-width='300'></smart-multi-input>

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

 const multiinput = document.querySelector('smart-multi-input');
 multiinput.dropDownWidth = 500;

Get the dropDownWidth property.

 const multiinput = document.querySelector('smart-multi-input');
 let dropDownWidth = multiinput.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-multi-input input-purpose='on'></smart-multi-input>

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

 const multiinput = document.querySelector('smart-multi-input');
 multiinput.inputPurpose = 'country';

Get the inputPurpose property.

 const multiinput = document.querySelector('smart-multi-input');
 let inputPurpose = multiinput.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-multi-input items='2'></smart-multi-input>

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

 const multiinput = document.querySelector('smart-multi-input');
 multiinput.items = 5;

Get the items property.

 const multiinput = document.querySelector('smart-multi-input');
 let items = multiinput.items;

localestring

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

Default value

"en"

Example

Set the locale property.

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

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

 const multiinput = document.querySelector('smart-multi-input');
 multiinput.locale = 'en';

Get the locale property.

 const multiinput = document.querySelector('smart-multi-input');
 let locale = multiinput.locale;

localizeFormatFunctionfunction

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

Example

Set the localizeFormatFunction property.

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

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

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

Get the localizeFormatFunction property.

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

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

 const multiinput = document.querySelector('smart-multi-input');
 multiinput.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 multiinput = document.querySelector('smart-multi-input');
 let messages = multiinput.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-multi-input min-length='2'></smart-multi-input>

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

 const multiinput = document.querySelector('smart-multi-input');
 multiinput.minLength = 0;

Get the minLength property.

 const multiinput = document.querySelector('smart-multi-input');
 let minLength = multiinput.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-multi-input name='dropdown'></smart-multi-input>

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

 const multiinput = document.querySelector('smart-multi-input');
 multiinput.name = 'dropDown2';

Get the name property.

 const multiinput = document.querySelector('smart-multi-input');
 let name = multiinput.name;

openedboolean

Determines whether the drop down is opened or not.

Default value

false

Example

Set the opened property.

 <smart-multi-input opened></smart-multi-input>

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

 const multiinput = document.querySelector('smart-multi-input');
 multiinput.opened = false;

Get the opened property.

 const multiinput = document.querySelector('smart-multi-input');
 let opened = multiinput.opened;

placeholderstring

Determines the placeholder of the input.

Default value

""

Example

Set the placeholder property.

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

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

 const multiinput = document.querySelector('smart-multi-input');
 multiinput.placeholder = 'Enter:';

Get the placeholder property.

 const multiinput = document.querySelector('smart-multi-input');
 let placeholder = multiinput.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-multi-input query='ABC'></smart-multi-input>

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

 const multiinput = document.querySelector('smart-multi-input');
 multiinput.query = 'some query';

Get the query property.

 const multiinput = document.querySelector('smart-multi-input');
 let query = multiinput.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.

Default value

"containsIgnoreCase"

Example

Set the queryMode property.

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

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

 const multiinput = document.querySelector('smart-multi-input');
 multiinput.queryMode = 'endsWith';

Get the queryMode property.

 const multiinput = document.querySelector('smart-multi-input');
 let queryMode = multiinput.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

Example

Set the readonly property.

 <smart-multi-input readonly></smart-multi-input>

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

 const multiinput = document.querySelector('smart-multi-input');
 multiinput.readonly = false;

Get the readonly property.

 const multiinput = document.querySelector('smart-multi-input');
 let readonly = multiinput.readonly;

rightToLeftboolean

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

Default value

false

Example

Set the rightToLeft property.

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

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

 const multiinput = document.querySelector('smart-multi-input');
 multiinput.rightToLeft = true;

Get the rightToLeft property.

 const multiinput = document.querySelector('smart-multi-input');
 let rightToLeft = multiinput.rightToLeft;

separatorstring

Determines the delimiter between the selected items in the input.

Default value

","

Example

Set the separator property.

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

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

 const multiinput = document.querySelector('smart-multi-input');
 multiinput.separator = ',';

Get the separator property.

 const multiinput = document.querySelector('smart-multi-input');
 let separator = multiinput.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-multi-input select-all></smart-multi-input>

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

 const multiinput = document.querySelector('smart-multi-input');
 multiinput.selectAll = false;

Get the selectAll property.

 const multiinput = document.querySelector('smart-multi-input');
 let selectAll = multiinput.selectAll;

sortedboolean

Determines whether the items are sorted alphabetically or not

Default value

false

Example

Set the sorted property.

 <smart-multi-input sorted></smart-multi-input>

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

 const multiinput = document.querySelector('smart-multi-input');
 multiinput.sorted = false;

Get the sorted property.

 const multiinput = document.querySelector('smart-multi-input');
 let sorted = multiinput.sorted;

sortDirectionstring

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

Default value

"asc"

Example

Set the sortDirection property.

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

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

 const multiinput = document.querySelector('smart-multi-input');
 multiinput.sortDirection = 'asc';

Get the sortDirection property.

 const multiinput = document.querySelector('smart-multi-input');
 let sortDirection = multiinput.sortDirection;

themestring

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

Default value

""

Example

Set the theme property.

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

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

 const multiinput = document.querySelector('smart-multi-input');
 multiinput.theme = 'red';

Get the theme property.

 const multiinput = document.querySelector('smart-multi-input');
 let theme = multiinput.theme;

typestring

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

Default value

""

Example

Set the type property.

 <smart-multi-input type='number'></smart-multi-input>

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

 const multiinput = document.querySelector('smart-multi-input');
 multiinput.type = 'text';

Get the type property.

 const multiinput = document.querySelector('smart-multi-input');
 let type = multiinput.type;

unfocusableboolean

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

Default value

false

Example

Set the unfocusable property.

 <smart-multi-input unfocusable></smart-multi-input>

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

 const multiinput = document.querySelector('smart-multi-input');
 multiinput.unfocusable = false;

Get the unfocusable property.

 const multiinput = document.querySelector('smart-multi-input');
 let unfocusable = multiinput.unfocusable;

valuestring

Sets or gets the value of the element.

Default value

""

Example

Set the value property.

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

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

 const multiinput = document.querySelector('smart-multi-input');
 multiinput.value = 'value2';

Get the value property.

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

Try a demo showcasing the close method.

ensureVisible(): void

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


Invoke the ensureVisible method.

const multiinput = document.querySelector('smart-multi-input');
multiinput.ensureVisible();

open(): void

Opens the drop down.


Invoke the open method.

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