ColorInput JAVASCRIPT UI Component API

ColorInput Javascript API

Class

ColorInput

ColorInput

ColorInput is an input field with colors displayed in a DropDown grid like in Excel.

Selector

smart-color-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 represent valid colors ) that will be loaded to the Input. The dataSource can be an array of strings 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.
DdisplayModeDetermines the colors that will be displayed and their layout.
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 the user can enter text inside the input or not. 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.
TthemeDetermines the theme for the element. Themes define the look of the elements.
UunfocusableIf is set to true, the element cannot be focused.
VvalueSets or gets the value of the element.
VvalueDisplayModeDetermines what will be displayed inside the color picker's action section.
VvalueFormatDetermines the format of the color. Whether it's in HEX, RGB or RGBA. By default it shows the color depending on the displayMode.

Events

CchangeThis event is triggered when the selection is changed.

Methods

CcloseCloses the drop down.
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-color-input animation='none'></smart-color-input>

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

 const colorinput = document.querySelector('smart-color-input');
 colorinput.animation = 'simple';

Get the animation property. 

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

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

 const colorinput = document.querySelector('smart-color-input');
 colorinput.autoCompleteDelay = 200;

Get the autoCompleteDelay property. 

 const colorinput = document.querySelector('smart-color-input');
 let autoCompleteDelay = colorinput.autoCompleteDelay;

dataSourceany

Determines the data source ( that represent valid colors ) that will be loaded to the Input. The dataSource can be an array of strings 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-color-input data-source='[{ label: "item 1", value: 1 }, { label: "item 2", value: 2 }]'></smart-color-input>

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

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

Get the dataSource property. 

 const colorinput = document.querySelector('smart-color-input');
 let dataSource = colorinput.dataSource;

disabledboolean

Enables or disables the element.

Default value

false
Try a demo showcasing the disabled property.

Example

Set the disabled property. 

 <smart-color-input disabled></smart-color-input>

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

 const colorinput = document.querySelector('smart-color-input');
 colorinput.disabled = false;

Get the disabled property. 

 const colorinput = document.querySelector('smart-color-input');
 let disabled = colorinput.disabled;

displayMode"default" | "grid"

Determines the colors that will be displayed and their layout.

Allowed Values

  • "default" - Represents a grid of all standart colors that are most frequently used.
  • "grid" - Represents a predefined grid of colors or a custom grid of colors. The dataSource property determines the colors that will be loaded in the grid.

Default value

"default"
Try a demo showcasing the displayMode property.

Example

Set the displayMode property. 

 <smart-color-input display-mode='grid'></smart-color-input>

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

 const colorinput = document.querySelector('smart-color-input');
 colorinput.displayMode = 'default';

Get the displayMode property. 

 const colorinput = document.querySelector('smart-color-input');
 let displayMode = colorinput.displayMode;

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

Determines the position of the drop down button.

Allowed Values

  • "left" - Positions the drop down button on the left side of the element.
  • "right" - Positions the drop down button on the right side of the element.
  • "top" - Positions the drop down button on the top side of the element.
  • "bottom" - Positions the drop down button on the bottom side of the element.

Default value

"none"

Example

Set the dropDownButtonPosition property. 

 <smart-color-input drop-down-button-position='left'></smart-color-input>

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

 const colorinput = document.querySelector('smart-color-input');
 colorinput.dropDownButtonPosition = 'right';

Get the dropDownButtonPosition property. 

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

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

 const colorinput = document.querySelector('smart-color-input');
 colorinput.dropDownHeight = 500;

Get the dropDownHeight property. 

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

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

 const colorinput = document.querySelector('smart-color-input');
 colorinput.dropDownWidth = 500;

Get the dropDownWidth property. 

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

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

 const colorinput = document.querySelector('smart-color-input');
 colorinput.inputPurpose = 'country';

Get the inputPurpose property. 

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

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

 const colorinput = document.querySelector('smart-color-input');
 colorinput.items = 5;

Get the items property. 

 const colorinput = document.querySelector('smart-color-input');
 let items = colorinput.items;

localestring

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

Default value

"en"

Example

Set the locale property. 

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

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

 const colorinput = document.querySelector('smart-color-input');
 colorinput.locale = 'en';

Get the locale property. 

 const colorinput = document.querySelector('smart-color-input');
 let locale = colorinput.locale;

localizeFormatFunctionfunction

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

Example

Set the localizeFormatFunction property. 

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

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

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

Get the localizeFormatFunction property. 

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

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

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

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

 const colorinput = document.querySelector('smart-color-input');
 colorinput.minLength = 0;

Get the minLength property. 

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

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

 const colorinput = document.querySelector('smart-color-input');
 colorinput.name = 'dropDown2';

Get the name property. 

 const colorinput = document.querySelector('smart-color-input');
 let name = colorinput.name;

openedboolean

Determines whether the drop down is opened or not.

Default value

false

Example

Set the opened property. 

 <smart-color-input opened></smart-color-input>

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

 const colorinput = document.querySelector('smart-color-input');
 colorinput.opened = false;

Get the opened property. 

 const colorinput = document.querySelector('smart-color-input');
 let opened = colorinput.opened;

placeholderstring

Determines the placeholder of the input.

Default value

""
Try a demo showcasing the placeholder property.

Example

Set the placeholder property. 

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

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

 const colorinput = document.querySelector('smart-color-input');
 colorinput.placeholder = 'Enter:';

Get the placeholder property. 

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

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

 const colorinput = document.querySelector('smart-color-input');
 colorinput.query = 'some query';

Get the query property. 

 const colorinput = document.querySelector('smart-color-input');
 let query = colorinput.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-color-input query-mode='contains'></smart-color-input>

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

 const colorinput = document.querySelector('smart-color-input');
 colorinput.queryMode = 'endsWith';

Get the queryMode property. 

 const colorinput = document.querySelector('smart-color-input');
 let queryMode = colorinput.queryMode;

readonlyboolean

Determines whether the user can enter text inside the input or not. 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-color-input readonly></smart-color-input>

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

 const colorinput = document.querySelector('smart-color-input');
 colorinput.readonly = false;

Get the readonly property. 

 const colorinput = document.querySelector('smart-color-input');
 let readonly = colorinput.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-color-input right-to-left></smart-color-input>

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

 const colorinput = document.querySelector('smart-color-input');
 colorinput.rightToLeft = true;

Get the rightToLeft property. 

 const colorinput = document.querySelector('smart-color-input');
 let rightToLeft = colorinput.rightToLeft;

themestring

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

Default value

""

Example

Set the theme property. 

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

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

 const colorinput = document.querySelector('smart-color-input');
 colorinput.theme = 'red';

Get the theme property. 

 const colorinput = document.querySelector('smart-color-input');
 let theme = colorinput.theme;

unfocusableboolean

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

Default value

false

Example

Set the unfocusable property. 

 <smart-color-input unfocusable></smart-color-input>

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

 const colorinput = document.querySelector('smart-color-input');
 colorinput.unfocusable = false;

Get the unfocusable property. 

 const colorinput = document.querySelector('smart-color-input');
 let unfocusable = colorinput.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-color-input value='#000000'></smart-color-input>

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

 const colorinput = document.querySelector('smart-color-input');
 colorinput.value = '#ffffff';

Get the value property. 

 const colorinput = document.querySelector('smart-color-input');
 let value = colorinput.value;

valueDisplayMode"default" | "colorBox" | "colorCode" | "none"

Determines what will be displayed inside the color picker's action section.

Allowed Values

  • "default" - The color box and the color code are displayed next to the drop down button.
  • "colorBox" - Only the color box is visible next to the drop down button.
  • "colorCode" - Only the color code is dispalyed next to the drop down button.
  • "none" - Only the drop down button is displayed.

Default value

"default"

Example

Set the valueDisplayMode property. 

 <smart-color-input value-display-mode='colorBox'></smart-color-input>

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

 const colorinput = document.querySelector('smart-color-input');
 colorinput.valueDisplayMode = 'default';

Get the valueDisplayMode property. 

 const colorinput = document.querySelector('smart-color-input');
 let valueDisplayMode = colorinput.valueDisplayMode;

valueFormat"default" | "rgb" | "rgba" | "hex"

Determines the format of the color. Whether it's in HEX, RGB or RGBA. By default it shows the color depending on the displayMode.

Allowed Values

  • "default" - The value is presented depending on the displayMode.
  • "rgb" - The value is presented as RGB color.
  • "rgba" - The value is presented as RGBA color.
  • "hex" - The value is presented as HEX color.

Default value

"default"

Example

Set the valueFormat property. 

 <smart-color-input value-format='rgba'></smart-color-input>

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

 const colorinput = document.querySelector('smart-color-input');
 colorinput.valueFormat = 'rgb';

Get the valueFormat property. 

 const colorinput = document.querySelector('smart-color-input');
 let valueFormat = colorinput.valueFormat;

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 color.
ev.detail.oldLabel - The label of the color that was previously selected before the event was triggered.
ev.detail.oldValue - The value of the color that was previously selected before the event was triggered.
ev.detail.value - The value of the new selected color.

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 colorinput = document.querySelector('smart-color-input');
colorinput.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 colorinput = document.querySelector('smart-color-input');
colorinput.close();

Try a demo showcasing the close method.

open(): void

Opens the drop down.


Invoke the open method.

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