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

AanimationConfigures or retrieves the current animation mode. When set to 'none', all animations are disabled, resulting in instant transitions with no visual effects. Otherwise, the property determines the type or style of animation used for transitions or dynamic effects.
AautoCompleteDelaySpecifies the amount of time, in milliseconds, to wait before displaying the dropdown list of matching results after the user initiates the autocomplete operation. This delay helps control how quickly the matches appear, improving user experience and performance when fetching or filtering suggestions.
DdataSourceSpecifies the source of data to be loaded into the Input component. The dataSource can accept the following formats:- An array of strings or numbers, where each value will be used as a list item.- An array of objects, where each object represents a list item with specific properties such as label (display text) and value (underlying value).- A callback function that returns an array of items in one of the formats described above.This flexibility allows you to provide simple lists or more complex data structures for Input population, as well as load data asynchronously or dynamically when needed.
DdisabledDetermines whether the element is interactive or inactive. When enabled, users can interact with the element (e.g., click, type, or select). When disabled, the element is visible but does not respond to user interactions.
DdropDownButtonPositionSpecifies the placement of the dropdown button relative to its parent element, such as aligning it to the left, right, top, or bottom. This property controls where the dropdown button appears within the interface.
DdropDownHeightSpecifies the height of the dropdown menu. By default, this property is set to an empty string, which means the dropdown's height is determined by a corresponding CSS variable. If a specific value is provided, it will override the CSS variable and explicitly set the dropdown's height.
DdropDownWidthSpecifies the width of the dropdown menu. By default, this property is set to an empty string (""), which means the dropdown’s width will be determined by the associated CSS variable (typically via a custom property such as --dropdown-width). To override the default behavior, you can explicitly set a specific width (e.g., "200px", "100%", etc.), which will be applied directly to the dropdown. If left as an empty string, the component remains responsive to changes in the relevant CSS variable.
IinputPurposeDefines the expected type of data for this input field and specifies whether, and to what extent, the browser or user agent is allowed to offer autofill assistance. This attribute aligns with the standard HTML autocomplete attribute, providing guidance to browsers for streamlining data entry and enhancing user experience. Acceptable values indicate the type of information anticipated, such as 'on' (enable autocomplete), 'off' (disable autocomplete), 'name' (full name), 'organization' (company or organization name), 'street-address' (street address), among others. Proper use of this attribute ensures accurate and secure autofill behavior in web forms.
IitemsSpecifies the maximum number of items that can be displayed in the dropdown list when a new autoComplete query is performed. This setting controls how many matched results are visible to the user at one time within the dropdown. By default, up to 8 matching items will be shown in the dropdown menu.
UunlockKeyDefines the 'unlockKey' property, which is used to retrieve or assign the unique key required to unlock access to the product. This property can be read to obtain the current unlock key or set to specify a new key for unlocking the product.
LlocaleSpecifies or retrieves the current language code, typically following ISO 639-1 standards (e.g., "en" for English, "fr" for French). This property is used alongside the messages property to determine which set of localized messages should be displayed or accessed based on the selected language.
LlocalizeFormatFunctionA callback function that allows you to define a custom format for messages returned by the Localization Module. Use this function to modify or enhance the appearance, structure, or content of localized messages before they are delivered to the application.
MmessagesDefines or retrieves an object containing text strings used within the widget that support localization. This property enables you to customize the widget’s displayed text for different languages or regions. It is typically used together with the locale property to provide translations and localize the widget’s interface.
MminLengthSpecifies the minimum number of characters a user must type into the input field before the autocomplete functionality is activated. Once this threshold is reached, the dropdown will open and display a list of items that match the entered text.
NnameGets or sets the 'name' attribute of the element. The 'name' attribute assigns an identifier to the element, which is used when submitting form data. When a form is submitted, the value of each input element with a 'name' attribute is included in the form data, using the 'name' as the key. This allows server-side scripts to reference the data by name.
OopenedSpecifies whether the dropdown menu is currently visible (open) or hidden (closed).
PplaceholderSpecifies the placeholder text that appears inside the input field when it is empty, providing a hint or example to guide the user on what to enter.
QquerySpecifies or retrieves the search query used to filter items within the data source. This query determines which items are displayed during the autoComplete operation. If the query is an empty string, the filter is not applied, and all items from the data source will be shown.
QqueryModeSpecifies the autocomplete query mode, which defines how user input is matched to suggestions. This property controls the underlying matching algorithm—such as prefix, infix, or fuzzy matching—used to generate autocomplete results, thereby influencing the relevance and style of suggestions presented to the user.
RreadonlySpecifies whether the user can enter text into the input field. When the dropDownButtonPosition property is set to 'left' or 'right', the readonly property controls the component’s behavior—if a dataSource is provided:- When readonly is false, the input functions as a ComboBox, allowing users to both type custom values and select from the dropdown list.- When readonly is true, the input behaves as a DropDownList, restricting users to select only from the available options in the dropdown and preventing any text input.
RresizeSpecifies whether the user is allowed to manually resize the Textarea component, enabling or disabling drag-to-resize functionality in the interface.
RrightToLeftSets or retrieves a value that determines whether the element’s alignment is adjusted to support right-to-left (RTL) languages, such as Arabic or Hebrew. When enabled, this property ensures that text direction and layout are suitable for locales that use right-to-left scripts.
RrichTextAllows you to toggle rich text formatting on or off, enabling users to apply styles such as bold, italics, lists, and other text enhancements when enabled, or restricting input to plain text when disabled.
SsortedSpecifies whether the items are arranged in alphabetical order. When set to true, the items will be automatically sorted from A to Z based on their names or labels; when set to false, the items will retain their original order as provided.
SsortDirectionSpecifies the sorting order to be applied when the sort option is enabled. Accepts either ascending (asc) to sort items from lowest to highest, or descending (desc) to sort items from highest to lowest.
TthemeSpecifies the visual theme applied to the element. The selected theme controls the appearance, including colors, fonts, and overall styling, ensuring a consistent look and feel across the element's user interface.
TtypeSpecifies the type of data that the input field accepts (e.g., text, number, email, password). Setting the input type helps control the kind of information users can enter, enables appropriate on-screen keyboards on mobile devices, and allows browsers to provide built-in validation for certain data formats.
UunfocusableWhen set to true, this property prevents the element from receiving keyboard focus, making it impossible to navigate to the element using the Tab key or programmatic focus methods (such as element.focus()).
UusersDefines the list of users available for mentioning in the TextArea component. Expects an array where each element is an object containing both id and name properties (e.g., { id: string | number, name: string }). When users type the '@' character, a dropdown appears, allowing them to select a user from this array to mention within the TextArea.
VvalueSets or retrieves the current value of the element, allowing you to programmatically update or access the element's value property. This is commonly used for form controls such as input, select, and textarea elements.

Events

CchangeThis event is triggered whenever the user's selection within the component changes. It fires each time a new item or range is selected, allowing you to respond to selection updates in real time. Use this event to perform actions such as updating related UI elements, fetching additional data, or validating the current selection.
CchangingThis event is triggered whenever a key is released (keyup) within the TextArea, but only if the content of the TextArea has changed since the previous event.

Methods

CcloseCloses the dropdown menu, hiding its list of selectable options from view.
EensureVisibleGuarantees that the currently active (selected) item remains in view within the scrollable area, automatically scrolling as needed to prevent it from being hidden or obscured.
GgetMentionsReturns an array containing information about all users who are mentioned (e.g., with “@username”) within the value of the Textarea. Each user object in the array represents a unique user mention detected in the Textarea's current content.
OopenExpands the drop-down menu, displaying its list of selectable options to the user.
SselectEnhances user interaction with input elements by selecting all the text within the input field. If the input element has the readonly attribute, the function instead sets focus on the element without selecting the text, since selection is not allowed for readonly inputs. This ensures an appropriate response whether the input is editable or not.

Properties

animation"none" | "simple" | "advanced"

Configures or retrieves the current animation mode. When set to 'none', all animations are disabled, resulting in instant transitions with no visual effects. Otherwise, the property determines the type or style of animation used for transitions or dynamic effects.

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

Specifies the amount of time, in milliseconds, to wait before displaying the dropdown list of matching results after the user initiates the autocomplete operation. This delay helps control how quickly the matches appear, improving user experience and performance when fetching or filtering suggestions.

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

Specifies the source of data to be loaded into the Input component. The dataSource can accept the following formats:

- An array of strings or numbers, where each value will be used as a list item.
- An array of objects, where each object represents a list item with specific properties such as label (display text) and value (underlying value).
- A callback function that returns an array of items in one of the formats described above.

This flexibility allows you to provide simple lists or more complex data structures for Input population, as well as load data asynchronously or dynamically when needed.

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

Determines whether the element is interactive or inactive. When enabled, users can interact with the element (e.g., click, type, or select). When disabled, the element is visible but does not respond to user interactions.

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"

Specifies the placement of the dropdown button relative to its parent element, such as aligning it to the left, right, top, or bottom. This property controls where the dropdown button appears within the interface.

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

Specifies the height of the dropdown menu. By default, this property is set to an empty string, which means the dropdown's height is determined by a corresponding CSS variable. If a specific value is provided, it will override the CSS variable and explicitly set the dropdown's height.

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

Specifies the width of the dropdown menu. By default, this property is set to an empty string (""), which means the dropdown’s width will be determined by the associated CSS variable (typically via a custom property such as --dropdown-width). To override the default behavior, you can explicitly set a specific width (e.g., "200px", "100%", etc.), which will be applied directly to the dropdown. If left as an empty string, the component remains responsive to changes in the relevant 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

Defines the expected type of data for this input field and specifies whether, and to what extent, the browser or user agent is allowed to offer autofill assistance. This attribute aligns with the standard HTML autocomplete attribute, providing guidance to browsers for streamlining data entry and enhancing user experience. Acceptable values indicate the type of information anticipated, such as 'on' (enable autocomplete), 'off' (disable autocomplete), 'name' (full name), 'organization' (company or organization name), 'street-address' (street address), among others. Proper use of this attribute ensures accurate and secure autofill behavior in web forms.

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

Specifies the maximum number of items that can be displayed in the dropdown list when a new autoComplete query is performed. This setting controls how many matched results are visible to the user at one time within the dropdown. By default, up to 8 matching items will be shown in the dropdown menu.

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;

unlockKeystring

Defines the 'unlockKey' property, which is used to retrieve or assign the unique key required to unlock access to the product. This property can be read to obtain the current unlock key or set to specify a new key for unlocking the product.

Default value

""

Example

Set the unlockKey property. 

 <smart-text-area unlock-key=''></smart-text-area>

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

 const textarea = document.querySelector('smart-text-area');
 textarea.unlockKey = '1111-2222-3333-4444-5555';

Get the unlockKey property. 

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

localestring

Specifies or retrieves the current language code, typically following ISO 639-1 standards (e.g., "en" for English, "fr" for French). This property is used alongside the messages property to determine which set of localized messages should be displayed or accessed based on the selected language.

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

A callback function that allows you to define a custom format for messages returned by the Localization Module. Use this function to modify or enhance the appearance, structure, or content of localized messages before they are delivered to the application.

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

Defines or retrieves an object containing text strings used within the widget that support localization. This property enables you to customize the widget’s displayed text for different languages or regions. It is typically used together with the locale property to provide translations and localize the widget’s interface.

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

Specifies the minimum number of characters a user must type into the input field before the autocomplete functionality is activated. Once this threshold is reached, the dropdown will open and display a list of items that match the entered text.

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

Gets or sets the 'name' attribute of the element. The 'name' attribute assigns an identifier to the element, which is used when submitting form data. When a form is submitted, the value of each input element with a 'name' attribute is included in the form data, using the 'name' as the key. This allows server-side scripts to reference the data by name.

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

Specifies whether the dropdown menu is currently visible (open) or hidden (closed).

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

Specifies the placeholder text that appears inside the input field when it is empty, providing a hint or example to guide the user on what to enter.

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

Specifies or retrieves the search query used to filter items within the data source. This query determines which items are displayed during the autoComplete operation. If the query is an empty string, the filter is not applied, and all items from the data source will be shown.

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"

Specifies the autocomplete query mode, which defines how user input is matched to suggestions. This property controls the underlying matching algorithm—such as prefix, infix, or fuzzy matching—used to generate autocomplete results, thereby influencing the relevance and style of suggestions presented to the user.

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

Specifies whether the user can enter text into the input field. When the dropDownButtonPosition property is set to 'left' or 'right', the readonly property controls the component’s behavior—if a dataSource is provided:

- When readonly is false, the input functions as a ComboBox, allowing users to both type custom values and select from the dropdown list.
- When readonly is true, the input behaves as a DropDownList, restricting users to select only from the available options in the dropdown and preventing any text input.

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"

Specifies whether the user is allowed to manually resize the Textarea component, enabling or disabling drag-to-resize functionality in the interface.

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 retrieves a value that determines whether the element’s alignment is adjusted to support right-to-left (RTL) languages, such as Arabic or Hebrew. When enabled, this property ensures that text direction and layout are suitable for locales that use right-to-left scripts.

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;

richTextboolean

Allows you to toggle rich text formatting on or off, enabling users to apply styles such as bold, italics, lists, and other text enhancements when enabled, or restricting input to plain text when disabled.

Default value

false
Try a demo showcasing the richText property.

Example

Set the richText property. 

 <smart-text-area rich-text></smart-text-area>

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

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

Get the richText property. 

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

sortedboolean

Specifies whether the items are arranged in alphabetical order. When set to true, the items will be automatically sorted from A to Z based on their names or labels; when set to false, the items will retain their original order as provided.

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

Specifies the sorting order to be applied when the sort option is enabled. Accepts either ascending (asc) to sort items from lowest to highest, or descending (desc) to sort items from highest to lowest.

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

Specifies the visual theme applied to the element. The selected theme controls the appearance, including colors, fonts, and overall styling, ensuring a consistent look and feel across the element's user interface.

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

Specifies the type of data that the input field accepts (e.g., text, number, email, password). Setting the input type helps control the kind of information users can enter, enables appropriate on-screen keyboards on mobile devices, and allows browsers to provide built-in validation for certain data formats.

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

When set to true, this property prevents the element from receiving keyboard focus, making it impossible to navigate to the element using the Tab key or programmatic focus methods (such as element.focus()).

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[]

Defines the list of users available for mentioning in the TextArea component. Expects an array where each element is an object containing both id and name properties (e.g., { id: string | number, name: string }). When users type the '@' character, a dropdown appears, allowing them to select a user from this array to mention within the TextArea.

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 retrieves the current value of the element, allowing you to programmatically update or access the element's value property. This is commonly used for form controls such as input, select, and textarea elements.

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 whenever the user's selection within the component changes. It fires each time a new item or range is selected, allowing you to respond to selection updates in real time. Use this event to perform actions such as updating related UI elements, fetching additional data, or validating the current selection.

  • 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 whenever a key is released (keyup) within the TextArea, but only if the content of the TextArea has changed since the previous event.

  • 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 dropdown menu, hiding its list of selectable options from view.


Invoke the close method.

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

Try a demo showcasing the close method.

ensureVisible(): void

Guarantees that the currently active (selected) item remains in view within the scrollable area, automatically scrolling as needed to prevent it from being hidden or obscured.


Invoke the ensureVisible method.

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

getMentions(): []

Returns an array containing information about all users who are mentioned (e.g., with “@username”) within the value of the Textarea. Each user object in the array represents a unique user mention detected in the Textarea's current content.

Returns[]

Invoke the getMentions method.

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

open(): void

Expands the drop-down menu, displaying its list of selectable options to the user.


Invoke the open method.

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

Try a demo showcasing the open method.

select(): void

Enhances user interaction with input elements by selecting all the text within the input field. If the input element has the readonly attribute, the function instead sets focus on the element without selecting the text, since selection is not allowed for readonly inputs. This ensures an appropriate response whether the input is editable or not.


Invoke the select method.

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