TextArea JAVASCRIPT UI Component API

TextArea Javascript API

Class

TextArea

TextArea

TextArea specifies a textarea field where the user can enter data. Auto-complete options are displayed for easier input.

Selector

smart-text-area

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.
RresizeDetermines whether ot not the user can resize the Textarea.
RrightToLeftSets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts.
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.
UusersSets the TextArea users. Expects an array of objects. Each object should have an id and name properties. When you press the 'at' key, you can enter an user from a dropdown.
VvalueSets or gets the value of the element.

Events

CchangeThis event is triggered when the selection is changed.
CchangingThis event is triggered on each key up event of the TextArea, if the value is changed.

Methods

CcloseCloses the drop down.
EensureVisibleEnsures that the active ( selected ) item is always visible.
GgetMentionsReturns an array of users mentioned in the Textarea's value.
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-text-area animation='none'></smart-text-area>

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

 const textarea = document.querySelector('smart-text-area');
 textarea.animation = 'simple';

Get the animation property. 

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

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

 const textarea = document.querySelector('smart-text-area');
 textarea.autoCompleteDelay = 200;

Get the autoCompleteDelay property. 

 const textarea = document.querySelector('smart-text-area');
 let autoCompleteDelay = textarea.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-text-area data-source='[{ label: "item 1", value: 1 }, { label: "item 2", value: 2 }]'></smart-text-area>

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

 const textarea = document.querySelector('smart-text-area');
 textarea.dataSource = ["new item 1", "new item 2"];

Get the dataSource property. 

 const textarea = document.querySelector('smart-text-area');
 let dataSource = textarea.dataSource;

disabledboolean

Enables or disables the element.

Default value

false
Try a demo showcasing the disabled property.

Example

Set the disabled property. 

 <smart-text-area disabled></smart-text-area>

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

 const textarea = document.querySelector('smart-text-area');
 textarea.disabled = false;

Get the disabled property. 

 const textarea = document.querySelector('smart-text-area');
 let disabled = textarea.disabled;

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

Determines the position of the drop down button.

Allowed Values

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

Default value

"right"
Try a demo showcasing the dropDownButtonPosition property.

Example

Set the dropDownButtonPosition property. 

 <smart-text-area drop-down-button-position='top'></smart-text-area>

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

 const textarea = document.querySelector('smart-text-area');
 textarea.dropDownButtonPosition = 'bottom';

Get the dropDownButtonPosition property. 

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

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

 const textarea = document.querySelector('smart-text-area');
 textarea.dropDownHeight = 500;

Get the dropDownHeight property. 

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

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

 const textarea = document.querySelector('smart-text-area');
 textarea.dropDownWidth = 500;

Get the dropDownWidth property. 

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

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

 const textarea = document.querySelector('smart-text-area');
 textarea.inputPurpose = 'country';

Get the inputPurpose property. 

 const textarea = document.querySelector('smart-text-area');
 let inputPurpose = textarea.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-text-area items='2'></smart-text-area>

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

 const textarea = document.querySelector('smart-text-area');
 textarea.items = 5;

Get the items property. 

 const textarea = document.querySelector('smart-text-area');
 let items = textarea.items;

localestring

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

Default value

"en"

Example

Set the locale property. 

 <smart-text-area locale='de'></smart-text-area>

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

 const textarea = document.querySelector('smart-text-area');
 textarea.locale = 'en';

Get the locale property. 

 const textarea = document.querySelector('smart-text-area');
 let locale = textarea.locale;

localizeFormatFunctionfunction

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

Example

Set the localizeFormatFunction property. 

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

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

 const textarea = document.querySelector('smart-text-area');
 textarea.localizeFormatFunction = function(defaultMessage, message, messageArguments){return '...'};

Get the localizeFormatFunction property. 

 const textarea = document.querySelector('smart-text-area');
 let localizeFormatFunction = textarea.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-text-area 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-text-area>

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

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

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

 const textarea = document.querySelector('smart-text-area');
 textarea.minLength = 0;

Get the minLength property. 

 const textarea = document.querySelector('smart-text-area');
 let minLength = textarea.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-text-area name='dropdown'></smart-text-area>

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

 const textarea = document.querySelector('smart-text-area');
 textarea.name = 'dropDown2';

Get the name property. 

 const textarea = document.querySelector('smart-text-area');
 let name = textarea.name;

openedboolean

Determines whether the drop down is opened or not.

Default value

false

Example

Set the opened property. 

 <smart-text-area opened></smart-text-area>

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

 const textarea = document.querySelector('smart-text-area');
 textarea.opened = false;

Get the opened property. 

 const textarea = document.querySelector('smart-text-area');
 let opened = textarea.opened;

placeholderstring

Determines the placeholder of the input.

Default value

""
Try a demo showcasing the placeholder property.

Example

Set the placeholder property. 

 <smart-text-area placeholder='Empty'></smart-text-area>

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

 const textarea = document.querySelector('smart-text-area');
 textarea.placeholder = 'Enter:';

Get the placeholder property. 

 const textarea = document.querySelector('smart-text-area');
 let placeholder = textarea.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-text-area query='ABC'></smart-text-area>

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

 const textarea = document.querySelector('smart-text-area');
 textarea.query = 'some query';

Get the query property. 

 const textarea = document.querySelector('smart-text-area');
 let query = textarea.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-text-area query-mode='contains'></smart-text-area>

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

 const textarea = document.querySelector('smart-text-area');
 textarea.queryMode = 'endsWith';

Get the queryMode property. 

 const textarea = document.querySelector('smart-text-area');
 let queryMode = textarea.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-text-area readonly></smart-text-area>

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

 const textarea = document.querySelector('smart-text-area');
 textarea.readonly = false;

Get the readonly property. 

 const textarea = document.querySelector('smart-text-area');
 let readonly = textarea.readonly;

resize"none" | "horizontal" | "vertical" | "both"

Determines whether ot not the user can resize the Textarea.

Default value

"none"
Try a demo showcasing the resize property.

Example

Set the resize property. 

 <smart-text-area resize='both'></smart-text-area>

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

 const textarea = document.querySelector('smart-text-area');
 textarea.resize = 'none';

Get the resize property. 

 const textarea = document.querySelector('smart-text-area');
 let resize = textarea.resize;

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-text-area right-to-left></smart-text-area>

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

 const textarea = document.querySelector('smart-text-area');
 textarea.rightToLeft = true;

Get the rightToLeft property. 

 const textarea = document.querySelector('smart-text-area');
 let rightToLeft = textarea.rightToLeft;

sortedboolean

Determines whether the items are sorted alphabetically or not

Default value

false

Example

Set the sorted property. 

 <smart-text-area sorted></smart-text-area>

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

 const textarea = document.querySelector('smart-text-area');
 textarea.sorted = false;

Get the sorted property. 

 const textarea = document.querySelector('smart-text-area');
 let sorted = textarea.sorted;

sortDirectionstring

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

Default value

"asc"

Example

Set the sortDirection property. 

 <smart-text-area sort-direction='desc'></smart-text-area>

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

 const textarea = document.querySelector('smart-text-area');
 textarea.sortDirection = 'asc';

Get the sortDirection property. 

 const textarea = document.querySelector('smart-text-area');
 let sortDirection = textarea.sortDirection;

themestring

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

Default value

""

Example

Set the theme property. 

 <smart-text-area theme='blue'></smart-text-area>

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

 const textarea = document.querySelector('smart-text-area');
 textarea.theme = 'red';

Get the theme property. 

 const textarea = document.querySelector('smart-text-area');
 let theme = textarea.theme;

typestring

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

Default value

""

Example

Set the type property. 

 <smart-text-area type='blue'></smart-text-area>

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

 const textarea = document.querySelector('smart-text-area');
 textarea.type = 'red';

Get the type property. 

 const textarea = document.querySelector('smart-text-area');
 let type = textarea.type;

unfocusableboolean

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

Default value

false

Example

Set the unfocusable property. 

 <smart-text-area unfocusable></smart-text-area>

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

 const textarea = document.querySelector('smart-text-area');
 textarea.unfocusable = false;

Get the unfocusable property. 

 const textarea = document.querySelector('smart-text-area');
 let unfocusable = textarea.unfocusable;

users[]

Sets the TextArea users. Expects an array of objects. Each object should have an id and name properties. When you press the 'at' key, you can enter an user from a dropdown.

Default value

[]

Example

Set the users property. 

 <smart-text-area users='[]'></smart-text-area>

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

 const textarea = document.querySelector('smart-text-area');
 textarea.users = [];

Get the users property. 

 const textarea = document.querySelector('smart-text-area');
 let users = textarea.users;

valuestring

Sets or gets the value of the element.

Default value

""
Try a demo showcasing the value property.

Example

Set the value property. 

 <smart-text-area value='value1'></smart-text-area>

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

 const textarea = document.querySelector('smart-text-area');
 textarea.value = 'value2';

Get the value property. 

 const textarea = document.querySelector('smart-text-area');
 let value = textarea.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 textarea = document.querySelector('smart-text-area');
textarea.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.
})

changingCustomEvent

This event is triggered on each key up event of the TextArea, if the value is changed.

  • Bubbles Yes
  • Cancelable Yes
  • Interface CustomEvent
  • Event handler property onChanging

Arguments

evCustomEvent
ev.detailObject
ev.detail.oldValue - The previous value before it was changed.
ev.detail.value - The new value.

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 changing event. 

const textarea = document.querySelector('smart-text-area');
textarea.addEventListener('changing', function (event) {
    const detail = event.detail,
        oldValue = detail.oldValue,
        value = detail.value;

	// event handling code goes here.
})

Methods

close(): void

Closes the drop down.


Invoke the close method.

const textarea = document.querySelector('smart-text-area');
textarea.close();

Try a demo showcasing the close method.

ensureVisible(): void

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


Invoke the ensureVisible method.

const textarea = document.querySelector('smart-text-area');
textarea.ensureVisible();

getMentions(): []

Returns an array of users mentioned in the Textarea's value.

Returns[]

Invoke the getMentions method.

const textarea = document.querySelector('smart-text-area');
const result = textarea.getMentions();

open(): void

Opens the drop down.


Invoke the open method.

const textarea = document.querySelector('smart-text-area');
textarea.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 textarea = document.querySelector('smart-text-area');
textarea.select();