@smart-webcomponents-angular/combobox 22.0.2 → 25.5.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -137,7 +137,7 @@ class ComboBoxComponent extends BaseElement {
137
137
  * The registered callback function called when a blur event occurs on the form elements.
138
138
  */
139
139
  this._onTouched = () => { };
140
- /** @description This event is triggered when the selection is changed.
140
+ /** @description This event is triggered whenever the user changes the current selection, such as highlighting different text or selecting a new item in a list. It allows you to detect and respond to updates in the selected content or options within the interface.
141
141
  * @param event. The custom event. Custom event was created with: event.detail( addedItems, disabled, index, label, removedItems, selected, value)
142
142
  * addedItems - An array of List items that have been selected.
143
143
  * disabled - A flag indicating whether or not the item that caused the change event is disabled.
@@ -148,13 +148,13 @@ class ComboBoxComponent extends BaseElement {
148
148
  * value - The value of the List item that triggered the event.
149
149
  */
150
150
  this.onChange = new EventEmitter();
151
- /** @description This event is triggered when the drop down list is closed.
151
+ /** @description This event is triggered when the drop-down list is closed, either by the user selecting an option or by clicking outside the menu. It occurs after the drop-down menu is no longer visible, allowing you to perform actions in response to the menu's closure.
152
152
  * @param event. The custom event. */
153
153
  this.onClose = new EventEmitter();
154
- /** @description This event is triggered when the drop down list is about to be closed. This event allows to cancel the closing operation calling event.preventDefault() in the event handler function.
154
+ /** @description This event is triggered right before the dropdown list is about to close, providing an opportunity to intervene. By calling event.preventDefault() within the event handler, you can cancel the closing operation, allowing you to perform validation, display a confirmation dialog, or execute custom logic before the dropdown is closed.
155
155
  * @param event. The custom event. */
156
156
  this.onClosing = new EventEmitter();
157
- /** @description This event is triggered when an item is clicked.
157
+ /** @description This event is triggered whenever a user clicks on a specific item, allowing you to execute custom actions in response to the user's selection. The event provides context about the clicked item, enabling you to access its properties or perform related updates within your application.
158
158
  * @param event. The custom event. Custom event was created with: event.detail( disabled, index, label, selected, value)
159
159
  * disabled - Indicates whether the List item that was clicked is disabled or not.
160
160
  * index - Indicates the index of the List item that was clicked.
@@ -163,29 +163,29 @@ class ComboBoxComponent extends BaseElement {
163
163
  * value - The value of the List item that was clicked.
164
164
  */
165
165
  this.onItemClick = new EventEmitter();
166
- /** @description This event is triggered when the drop down list is opened.
166
+ /** @description This event is triggered whenever the dropdown list becomes visible to the user, such as when the user clicks or interacts with the control to expand and display the list of available options. Use this event to execute custom logic when the dropdown menu is opened.
167
167
  * @param event. The custom event. */
168
168
  this.onOpen = new EventEmitter();
169
- /** @description This event is triggered when the drop down list is about to be opened. This event allows to cancel the opening operation calling event.preventDefault() in the event handler function.
169
+ /** @description This event is triggered immediately before the dropdown list is displayed to the user. Within the event handler, you can prevent the dropdown from opening by calling event.preventDefault(). This allows you to implement custom logic to conditionally allow or block the opening of the dropdown, such as validating conditions or managing user permissions before the list is shown.
170
170
  * @param event. The custom event. */
171
171
  this.onOpening = new EventEmitter();
172
- /** @description This event is triggered when user starts resizing the drop down.
172
+ /** @description This event is triggered when the user initiates the resizing action on the dropdown component, such as clicking and dragging a resize handle. It allows developers to detect the exact moment when a resize operation on the dropdown begins.
173
173
  * @param event. The custom event. Custom event was created with: event.detail( position)
174
174
  * position - An object containing the current left and top positions of the drop down.
175
175
  */
176
176
  this.onResizeStart = new EventEmitter();
177
- /** @description This event is triggered when the resizing of the drop down is finished.
177
+ /** @description This event is triggered after the user has completed resizing the dropdown menu, signaling that the resizing action has ended and the new dimensions have been set.
178
178
  * @param event. The custom event. Custom event was created with: event.detail( position)
179
179
  * position - An object containing the current left and top positions of the drop down.
180
180
  */
181
181
  this.onResizeEnd = new EventEmitter();
182
- /** @description This event is triggered when user scrolls to the end of the dropDown list.
182
+ /** @description This event is triggered when the user scrolls to the bottom of the dropdown list, indicating that all available options have been displayed. It can be used to detect when additional data should be loaded or when no further options remain in the dropdown.
183
183
  * @param event. The custom event. */
184
184
  this.onScrollBottomReached = new EventEmitter();
185
- /** @description This event is triggered when user scrolls to the start of the dropDown list.
185
+ /** @description This event is triggered when the user scrolls to the very beginning (top) of the dropdown list, indicating that no more items are available above the current view.
186
186
  * @param event. The custom event. */
187
187
  this.onScrollTopReached = new EventEmitter();
188
- /** @description This event is triggered when a token item(pill) has been clicked. This event allows to cancel the opening operation calling event.preventDefault() in the event handler function.
188
+ /** @description This event is triggered when a token item (also known as a 'pill') is clicked by the user. By handling this event, developers have the opportunity to intercept the default action that would normally occur when the token is clicked—such as opening a dropdown or performing another related operation. To prevent the default behavior from executing, call event.preventDefault() within your event handler function."
189
189
  * @param event. The custom event. */
190
190
  this.onTokenClick = new EventEmitter();
191
191
  this._initialChange = true;
@@ -201,462 +201,462 @@ class ComboBoxComponent extends BaseElement {
201
201
  }
202
202
  return this.nativeElement;
203
203
  }
204
- /** @description Used only when dropDownOpenMode is set to 'auto'. Determines the delay before the opened drop down closes if the pointer is not over the element. */
204
+ /** @description This property is applicable only when dropDownOpenMode is set to 'auto'. It specifies the amount of time (in milliseconds) the dropdown will remain open after the pointer leaves the element, before it automatically closes. If the pointer is not hovering over the dropdown or its trigger element, the dropdown will close after this delay. */
205
205
  get autoCloseDelay() {
206
206
  return this.nativeElement ? this.nativeElement.autoCloseDelay : undefined;
207
207
  }
208
208
  set autoCloseDelay(value) {
209
209
  this.nativeElement ? this.nativeElement.autoCloseDelay = value : undefined;
210
210
  }
211
- /** @description Determines the autocomplete mode. Auto complete modes filter the items from the dataSource and show only those that match the input. */
211
+ /** @description Specifies the autocomplete mode for the input field. The selected mode defines how the component filters and displays items from the dataSource, showing only those entries that match the user's input according to the chosen matching strategy. This setting directly impacts the suggestions presented to the user as they type. */
212
212
  get autoComplete() {
213
213
  return this.nativeElement ? this.nativeElement.autoComplete : undefined;
214
214
  }
215
215
  set autoComplete(value) {
216
216
  this.nativeElement ? this.nativeElement.autoComplete = value : undefined;
217
217
  }
218
- /** @description Determines the delay before the drop down opens to show the matches from the auto complete operation. The delay is measured in miliseconds. */
218
+ /** @description Specifies the amount of time, in milliseconds, to wait after the user input before displaying the dropdown list of autocomplete suggestions. This delay helps control how quickly the suggestions appear, allowing for smoother user experience and reducing unnecessary searches as the user types. */
219
219
  get autoCompleteDelay() {
220
220
  return this.nativeElement ? this.nativeElement.autoCompleteDelay : undefined;
221
221
  }
222
222
  set autoCompleteDelay(value) {
223
223
  this.nativeElement ? this.nativeElement.autoCompleteDelay = value : undefined;
224
224
  }
225
- /** @description Allows the user to define a custom key name ( or multiple key names) to open that popup with. */
225
+ /** @description Enables users to specify one or more custom key names that will trigger the opening of the popup when pressed. This allows for flexible keyboard shortcuts tailored to user preferences or application requirements. */
226
226
  get autoOpenShortcutKey() {
227
227
  return this.nativeElement ? this.nativeElement.autoOpenShortcutKey : undefined;
228
228
  }
229
229
  set autoOpenShortcutKey(value) {
230
230
  this.nativeElement ? this.nativeElement.autoOpenShortcutKey = value : undefined;
231
231
  }
232
- /** @description Determines the data source that will be loaded to the ComboBox. 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, group. It can also be a callback that returns an Array of items as previously described. */
232
+ /** @description Specifies the source of data to populate the ComboBox. The dataSource can be provided in several formats:- An array of strings or numbers, where each item becomes a selectable option in the ComboBox.- An array of objects, where each object represents a list item and its properties define the displayed information and associated value (e.g., label for display text, value for the underlying value, and optionally group to categorize items).- A callback function that returns an array of items in either of the above formats, enabling dynamic or asynchronous data loading.This flexible dataSource configuration allows the ComboBox to support simple lists, categorized lists, or dynamically retrieved data. */
233
233
  get dataSource() {
234
234
  return this.nativeElement ? this.nativeElement.dataSource : undefined;
235
235
  }
236
236
  set dataSource(value) {
237
237
  this.nativeElement ? this.nativeElement.dataSource = value : undefined;
238
238
  }
239
- /** @description Enables or disables the combo box. */
239
+ /** @description Controls whether the combo box is active or inactive. When enabled, users can interact with the combo box to select or enter a value. When disabled, the combo box is non-interactive and appears grayed out, preventing any user input or selection. */
240
240
  get disabled() {
241
241
  return this.nativeElement ? this.nativeElement.disabled : undefined;
242
242
  }
243
243
  set disabled(value) {
244
244
  this.nativeElement ? this.nativeElement.disabled = value : undefined;
245
245
  }
246
- /** @description Determines whether an indicator will appear during filtering and remote item loading. */
246
+ /** @description Specifies whether a visual indicator (such as a loading spinner or progress bar) will be displayed while filtering data locally or when retrieving items from a remote source. This helps inform users that a filtering operation or data fetch is in progress. */
247
247
  get displayLoadingIndicator() {
248
248
  return this.nativeElement ? this.nativeElement.displayLoadingIndicator : undefined;
249
249
  }
250
250
  set displayLoadingIndicator(value) {
251
251
  this.nativeElement ? this.nativeElement.displayLoadingIndicator = value : undefined;
252
252
  }
253
- /** @description Sets or gets the displayMember. The displayMember specifies the name of a property to display. The name is contained in the collection specified by the 'dataSource' property. */
253
+ /** @description Sets or retrieves the displayMember property. The displayMember property defines the specific field name within each data object in the collection provided by the 'dataSource' property. This field's value is used for displaying items in the UI component, allowing you to control which attribute of your data objects is shown to the user. */
254
254
  get displayMember() {
255
255
  return this.nativeElement ? this.nativeElement.displayMember : undefined;
256
256
  }
257
257
  set displayMember(value) {
258
258
  this.nativeElement ? this.nativeElement.displayMember = value : undefined;
259
259
  }
260
- /** @description Determines the drop down parent. The expected value is CSS Selector, ID or 'body'. The drop down can be removed from the body of the element and continue to work in another container. This is usefull when one of the parents of the element doesn't allow overflowing, by settings this property to 'body' the drop down will be appended to the DOM and the popup will open/close as usual. dropDownAppendTo can be a string representing the id of an HTML element on the page or a direct reference to that element. Reseting it back to null will take the drop down back to it's original place. */
260
+ /** @description Specifies the parent container for the dropdown element. The dropDownAppendTo property accepts a CSS selector string, an element's ID, the string value 'body', or a direct reference to an HTML element. By default, the dropdown is appended to its original parent in the DOM. However, if one of the containing elements has CSS properties (such as overflow: hidden) that restrict the dropdown's visibility, you can set this property—commonly to 'body'—to append the dropdown directly to the <body> element and ensure it displays properly.Possible values:- A CSS selector string (e.g., '.container' or '#mainDiv')- The string 'body'- A direct reference to an existing HTML element- An element's ID (as a string)- null (to reset and move the dropdown back to its original parent)This property improves compatibility in layouts with restricted overflow by allowing the dropdown to be rendered in a container of your choosing. Resetting dropDownAppendTo to null restores the dropdown to its initial placement within the DOM. */
261
261
  get dropDownAppendTo() {
262
262
  return this.nativeElement ? this.nativeElement.dropDownAppendTo : undefined;
263
263
  }
264
264
  set dropDownAppendTo(value) {
265
265
  this.nativeElement ? this.nativeElement.dropDownAppendTo = value : undefined;
266
266
  }
267
- /** @description Determines the position of the drop down button. */
267
+ /** @description Specifies the location of the dropdown button relative to its associated input field or container. Possible positions may include "left," "right," "top," or "bottom," allowing developers to control where the dropdown button appears in the user interface. */
268
268
  get dropDownButtonPosition() {
269
269
  return this.nativeElement ? this.nativeElement.dropDownButtonPosition : undefined;
270
270
  }
271
271
  set dropDownButtonPosition(value) {
272
272
  this.nativeElement ? this.nativeElement.dropDownButtonPosition = value : undefined;
273
273
  }
274
- /** @description 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. */
274
+ /** @description Specifies the height of the dropdown menu. By default, this property is set to an empty string, which means the dropdown’s height will be determined by the corresponding CSS variable. If a specific value is provided, it will override the CSS variable and set the dropdown height explicitly. */
275
275
  get dropDownHeight() {
276
276
  return this.nativeElement ? this.nativeElement.dropDownHeight : undefined;
277
277
  }
278
278
  set dropDownHeight(value) {
279
279
  this.nativeElement ? this.nativeElement.dropDownHeight = value : undefined;
280
280
  }
281
- /** @description Sets the maximum Height of the drop down. By default it's set to an empty string. In this case the maxHeight of the drop down is controlled by a CSS variable. */
281
+ /** @description Specifies the maximum height of the dropdown menu. By default, this value is set to an empty string, which means the dropdown's max-height will be controlled by a CSS variable instead of an explicit value. If you provide a specific value (e.g., "300px" or "50vh"), it will override the default CSS variable and directly set the maximum height of the dropdown. */
282
282
  get dropDownMaxHeight() {
283
283
  return this.nativeElement ? this.nativeElement.dropDownMaxHeight : undefined;
284
284
  }
285
285
  set dropDownMaxHeight(value) {
286
286
  this.nativeElement ? this.nativeElement.dropDownMaxHeight = value : undefined;
287
287
  }
288
- /** @description Sets the maximum Width of the drop down. By default it's set to an empty string. In this case the maxWidth of the drop down is controlled by a CSS variable. */
288
+ /** @description Defines the maximum width of the dropdown menu. By default, this value is set to an empty string, which means the dropdown's maximum width will be determined by a corresponding CSS variable. If a specific value is provided (e.g., "300px" or "50%"), it will override the CSS variable and directly set the maximum width of the dropdown. */
289
289
  get dropDownMaxWidth() {
290
290
  return this.nativeElement ? this.nativeElement.dropDownMaxWidth : undefined;
291
291
  }
292
292
  set dropDownMaxWidth(value) {
293
293
  this.nativeElement ? this.nativeElement.dropDownMaxWidth = value : undefined;
294
294
  }
295
- /** @description Sets the minimum Height of the drop down. By default it's set to an empty string. In this case the minHeight of the drop down is controlled by a CSS variable. */
295
+ /** @description Defines the minimum height of the dropdown component. By default, this property is set to an empty string, which means the dropdown's minimum height is determined by a corresponding CSS variable. If a specific value is provided for this property, it will override the CSS variable and explicitly set the dropdown's minimum height. */
296
296
  get dropDownMinHeight() {
297
297
  return this.nativeElement ? this.nativeElement.dropDownMinHeight : undefined;
298
298
  }
299
299
  set dropDownMinHeight(value) {
300
300
  this.nativeElement ? this.nativeElement.dropDownMinHeight = value : undefined;
301
301
  }
302
- /** @description Sets the minimum Width of the drop down. By default it's set to an empty string. In this case the minWidth of the drop down is controlled by a CSS variable. */
302
+ /** @description Specifies the minimum width of the dropdown component. By default, this property is set to an empty string (""). When left unset, the dropdown’s minimum width is determined by a CSS variable, allowing for flexible styling through external stylesheets. To override the CSS value, assign a specific width value (e.g., "200px" or "10rem") to this property. */
303
303
  get dropDownMinWidth() {
304
304
  return this.nativeElement ? this.nativeElement.dropDownMinWidth : undefined;
305
305
  }
306
306
  set dropDownMinWidth(value) {
307
307
  this.nativeElement ? this.nativeElement.dropDownMinWidth = value : undefined;
308
308
  }
309
- /** @description Determines how the drop down is going to open. */
309
+ /** @description Specifies the direction or animation in which the dropdown menu will appear when activated, such as opening upwards, downwards, or with a specific transition effect. */
310
310
  get dropDownOpenMode() {
311
311
  return this.nativeElement ? this.nativeElement.dropDownOpenMode : undefined;
312
312
  }
313
313
  set dropDownOpenMode(value) {
314
314
  this.nativeElement ? this.nativeElement.dropDownOpenMode = value : undefined;
315
315
  }
316
- /** @description If this property is enabled, when the element's dropdown is opened, a transparent overlay is positioned between the dropdown and the rest of the document. The purpose of the overlay is to make sure that clicking anywhere outside the popup will will target the overlay and not the DOM. */
316
+ /** @description If this property is enabled, opening the element's dropdown will insert a transparent overlay between the dropdown and the rest of the document. This overlay covers the entire viewport except for the dropdown itself, capturing all click events outside the dropdown. As a result, any clicks outside the popup will interact with the overlay instead of other elements on the page, allowing you to reliably detect and handle outside clicks (such as to close the dropdown) without unintentionally triggering other DOM elements. */
317
317
  get dropDownOverlay() {
318
318
  return this.nativeElement ? this.nativeElement.dropDownOverlay : undefined;
319
319
  }
320
320
  set dropDownOverlay(value) {
321
321
  this.nativeElement ? this.nativeElement.dropDownOverlay = value : undefined;
322
322
  }
323
- /** @description Determines the placeholder for the drop down, displayed when there are no items in it. */
323
+ /** @description Specifies the text or content to be shown in the dropdown as a placeholder when the dropdown contains no selectable items. This placeholder provides guidance or context to the user, indicating that there are currently no available options. */
324
324
  get dropDownPlaceholder() {
325
325
  return this.nativeElement ? this.nativeElement.dropDownPlaceholder : undefined;
326
326
  }
327
327
  set dropDownPlaceholder(value) {
328
328
  this.nativeElement ? this.nativeElement.dropDownPlaceholder = value : undefined;
329
329
  }
330
- /** @description Determines the position of the drop down when opened. */
330
+ /** @description Specifies the placement of the dropdown menu relative to its trigger element when opened (e.g., above, below, left, or right). This setting controls where the dropdown appears on the screen in relation to the element that activates it. */
331
331
  get dropDownPosition() {
332
332
  return this.nativeElement ? this.nativeElement.dropDownPosition : undefined;
333
333
  }
334
334
  set dropDownPosition(value) {
335
335
  this.nativeElement ? this.nativeElement.dropDownPosition = value : undefined;
336
336
  }
337
- /** @description 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. */
337
+ /** @description Specifies the width of the dropdown menu. By default, this property is set to an empty string, allowing the dropdown's width to be determined by the associated CSS variable (typically via custom properties or theme settings). If a value is provided, it overrides the CSS variable and directly sets the dropdown's width. */
338
338
  get dropDownWidth() {
339
339
  return this.nativeElement ? this.nativeElement.dropDownWidth : undefined;
340
340
  }
341
341
  set dropDownWidth(value) {
342
342
  this.nativeElement ? this.nativeElement.dropDownWidth = value : undefined;
343
343
  }
344
- /** @description Determines the behavior of the element when Escape key is pressed. */
344
+ /** @description Specifies how the element should respond when the Escape key is pressed by the user. This property allows you to define actions such as closing a modal, dismissing a dialog, or triggering a custom event when the Escape key is detected while the element is focused or active. */
345
345
  get escKeyMode() {
346
346
  return this.nativeElement ? this.nativeElement.escKeyMode : undefined;
347
347
  }
348
348
  set escKeyMode(value) {
349
349
  this.nativeElement ? this.nativeElement.escKeyMode = value : undefined;
350
350
  }
351
- /** @description Determines whether filtering is enabled. */
351
+ /** @description Specifies whether the filtering feature is active. When set to true, users can apply filters to narrow down displayed data; when false, filtering options are disabled and all data is shown without restriction. */
352
352
  get filterable() {
353
353
  return this.nativeElement ? this.nativeElement.filterable : undefined;
354
354
  }
355
355
  set filterable(value) {
356
356
  this.nativeElement ? this.nativeElement.filterable = value : undefined;
357
357
  }
358
- /** @description Determines the placeholder for the drop down list filter input field. */
358
+ /** @description Specifies the placeholder text displayed inside the dropdown list’s filter input field, guiding users on what to enter when searching or filtering options. */
359
359
  get filterInputPlaceholder() {
360
360
  return this.nativeElement ? this.nativeElement.filterInputPlaceholder : undefined;
361
361
  }
362
362
  set filterInputPlaceholder(value) {
363
363
  this.nativeElement ? this.nativeElement.filterInputPlaceholder = value : undefined;
364
364
  }
365
- /** @description Determines the filtering mode of the Combo box. */
365
+ /** @description Specifies the filtering behavior for the Combo Box, controlling how user input is matched against the available options (e.g., contains, starts with, or exact match). This property determines which options are displayed in the dropdown list as the user types. */
366
366
  get filterMode() {
367
367
  return this.nativeElement ? this.nativeElement.filterMode : undefined;
368
368
  }
369
369
  set filterMode(value) {
370
370
  this.nativeElement ? this.nativeElement.filterMode = value : undefined;
371
371
  }
372
- /** @description If enabled, the items will be grouped by their first letter. Can't be applied if the dataSource already contains groups. */
372
+ /** @description When enabled, this option automatically groups the items based on the first letter of each item's value or label. Note: This grouping feature is only available if the dataSource does not already include predefined groups. If the dataSource is already grouped, this setting will have no effect. */
373
373
  get grouped() {
374
374
  return this.nativeElement ? this.nativeElement.grouped : undefined;
375
375
  }
376
376
  set grouped(value) {
377
377
  this.nativeElement ? this.nativeElement.grouped = value : undefined;
378
378
  }
379
- /** @description Determines which attribute from the dataSource object will be used as the group member for the items. If not set, by default 'group' property is used from the source object. groupMember is especially usefull when loading the data from a JSON file as a dataSource for the ListBox and there's a specific property that should be used to group the items. */
379
+ /** @description Specifies which attribute of the dataSource object should be used to group items in the ListBox. By default, if this property (groupMember) is not set, the ListBox will use the 'group' property from each dataSource item to organize groups. This property is particularly useful when loading data from a JSON file, allowing you to designate a specific property from your data objects to determine the grouping of items—especially if your JSON structure uses a different property name for grouping. */
380
380
  get groupMember() {
381
381
  return this.nativeElement ? this.nativeElement.groupMember : undefined;
382
382
  }
383
383
  set groupMember(value) {
384
384
  this.nativeElement ? this.nativeElement.groupMember = value : undefined;
385
385
  }
386
- /** @description Sets additional helper text below the element. The hint is visible only when the element is focused. */
386
+ /** @description Displays supplementary helper text beneath the element. This hint is visible exclusively when the element is in focus, providing contextual guidance to users as they interact with the field. */
387
387
  get hint() {
388
388
  return this.nativeElement ? this.nativeElement.hint : undefined;
389
389
  }
390
390
  set hint(value) {
391
391
  this.nativeElement ? this.nativeElement.hint = value : undefined;
392
392
  }
393
- /** @description Determines the visibility of the horizontal Scroll bar inside the drop down. */
393
+ /** @description Controls whether the horizontal scroll bar is displayed within the dropdown menu when the content exceeds the available width. */
394
394
  get horizontalScrollBarVisibility() {
395
395
  return this.nativeElement ? this.nativeElement.horizontalScrollBarVisibility : undefined;
396
396
  }
397
397
  set horizontalScrollBarVisibility(value) {
398
398
  this.nativeElement ? this.nativeElement.horizontalScrollBarVisibility = value : undefined;
399
399
  }
400
- /** @description Represents the property name of a List item. Determines the value of the input when a ListItem is selected. Usefull in cases where the user wants to display for example the value of an item instead of it's label. By default the label is displayed in the input. */
400
+ /** @description Represents the property name of a List item whose value will be displayed in the input field when a ListItem is selected. This allows developers to control which property of each item is shown in the input, such as displaying the item's value instead of its label. By default, the label property is used for display. This option is useful when you want to customize the displayed content, for example, to show a unique identifier or value rather than the descriptive label. */
401
401
  get inputMember() {
402
402
  return this.nativeElement ? this.nativeElement.inputMember : undefined;
403
403
  }
404
404
  set inputMember(value) {
405
405
  this.nativeElement ? this.nativeElement.inputMember = value : undefined;
406
406
  }
407
- /** @description 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. */
407
+ /** @description Specifies the expected type of information for the input field and informs the browser about the nature of the data to be entered. This guidance allows user agents (such as browsers and password managers) to determine if they can provide automated assistance—like autofilling relevant values—when the element is used in a form. The value assigned to this property directly maps to the standard HTML autocomplete attribute. Common values include 'on' (enable autocomplete), 'off' (disable autocomplete), 'name' (full name), 'organization' (company or organization), 'email', 'street-address', and many others, as specified by the HTML standard. Using an appropriate value improves user experience, enhances accessibility, and helps maintain privacy and security standards within web forms. */
408
408
  get inputPurpose() {
409
409
  return this.nativeElement ? this.nativeElement.inputPurpose : undefined;
410
410
  }
411
411
  set inputPurpose(value) {
412
412
  this.nativeElement ? this.nativeElement.inputPurpose = value : undefined;
413
413
  }
414
- /** @description IncrementalSearchDelay property specifies the time-interval in milliseconds until the previous search query is cleared. The timer starts when the user stops typing. A new query can be started only when the delay has passed. */
414
+ /** @description The 'IncrementalSearchDelay' property defines the duration, in milliseconds, to wait after the user stops typing before clearing the previous search query. This timer begins as soon as the user finishes typing. During this delay period, no new search query will be initiated. Only after the specified delay has elapsed will the current search input be cleared, allowing a new search query to be started. This helps to optimize performance and user experience by preventing unnecessary or premature queries while the user is still entering their search terms. */
415
415
  get incrementalSearchDelay() {
416
416
  return this.nativeElement ? this.nativeElement.incrementalSearchDelay : undefined;
417
417
  }
418
418
  set incrementalSearchDelay(value) {
419
419
  this.nativeElement ? this.nativeElement.incrementalSearchDelay = value : undefined;
420
420
  }
421
- /** @description Sets ot gets the mode of the incremental search mode. Incremental search is enabled by default. Typing while the drop down is focused starts the incremental search. */
421
+ /** @description Configures or retrieves the current mode of incremental search. By default, incremental search is enabled, allowing users to type while the dropdown is focused to quickly filter and highlight matching options. Modifying this setting controls how user input is processed for searching within the dropdown list. */
422
422
  get incrementalSearchMode() {
423
423
  return this.nativeElement ? this.nativeElement.incrementalSearchMode : undefined;
424
424
  }
425
425
  set incrementalSearchMode(value) {
426
426
  this.nativeElement ? this.nativeElement.incrementalSearchMode = value : undefined;
427
427
  }
428
- /** @description Sets the height for all list items. Used only when virtualization is enabled. */
428
+ /** @description Specifies the height (in pixels) for each list item when rendering the list. This property is only applicable when list virtualization is enabled, as it helps optimize rendering performance by allowing the component to calculate and render only the visible items. */
429
429
  get itemHeight() {
430
430
  return this.nativeElement ? this.nativeElement.itemHeight : undefined;
431
431
  }
432
432
  set itemHeight(value) {
433
433
  this.nativeElement ? this.nativeElement.itemHeight = value : undefined;
434
434
  }
435
- /** @description Determines the item width measuring algorithm. */
435
+ /** @description Specifies the algorithm used to calculate the width of each item. This setting determines how the width of an item is measured, such as using the item's intrinsic content size, a fixed value, or a percentage of the container. Adjust this parameter to control how item widths are determined within the layout. */
436
436
  get itemMeasureMode() {
437
437
  return this.nativeElement ? this.nativeElement.itemMeasureMode : undefined;
438
438
  }
439
439
  set itemMeasureMode(value) {
440
440
  this.nativeElement ? this.nativeElement.itemMeasureMode = value : undefined;
441
441
  }
442
- /** @description A getter that returns an array of all List items inside the drop down. */
442
+ /** @description A getter method that retrieves and returns an array containing all list ('li') elements currently present within the dropdown menu. This allows you to easily access and manipulate every item displayed in the dropdown. */
443
443
  get items() {
444
444
  return this.nativeElement ? this.nativeElement.items : undefined;
445
445
  }
446
446
  set items(value) {
447
447
  this.nativeElement ? this.nativeElement.items = value : undefined;
448
448
  }
449
- /** @description The itemTemplate property is a string that represents the id of an HTMLTemplateElement in the DOM. It's used to set a customize the content of the list items. */
449
+ /** @description The itemTemplate property is a string that specifies the ID of an HTMLTemplateElement present in the DOM. This template is used to define and customize the structure and content of individual list items, allowing developers to control how each item appears when rendered in the list. */
450
450
  get itemTemplate() {
451
451
  return this.nativeElement ? this.nativeElement.itemTemplate : undefined;
452
452
  }
453
453
  set itemTemplate(value) {
454
454
  this.nativeElement ? this.nativeElement.itemTemplate = value : undefined;
455
455
  }
456
- /** @description Sets a little text label above the element. */
456
+ /** @description Displays a small text label positioned above the element, typically used to provide context, instructions, or additional information to users. */
457
457
  get label() {
458
458
  return this.nativeElement ? this.nativeElement.label : undefined;
459
459
  }
460
460
  set label(value) {
461
461
  this.nativeElement ? this.nativeElement.label = value : undefined;
462
462
  }
463
- /** @description Determines the text that will be displayed next to the loading indicator when the loader is visible and it's position is top or bottom. */
463
+ /** @description Specifies the text that appears alongside the loading indicator when the loader is visible and positioned at the top or bottom of the component. This text provides users with contextual information or status updates during loading. */
464
464
  get loadingIndicatorPlaceholder() {
465
465
  return this.nativeElement ? this.nativeElement.loadingIndicatorPlaceholder : undefined;
466
466
  }
467
467
  set loadingIndicatorPlaceholder(value) {
468
468
  this.nativeElement ? this.nativeElement.loadingIndicatorPlaceholder = value : undefined;
469
469
  }
470
- /** @description Determines the position of the loading indicator. */
470
+ /** @description Specifies the exact location on the user interface where the loading indicator will be displayed, such as at the top, center, or bottom of the screen or component. */
471
471
  get loadingIndicatorPosition() {
472
472
  return this.nativeElement ? this.nativeElement.loadingIndicatorPosition : undefined;
473
473
  }
474
474
  set loadingIndicatorPosition(value) {
475
475
  this.nativeElement ? this.nativeElement.loadingIndicatorPosition = value : undefined;
476
476
  }
477
- /** @description Sets or gets the unlockKey which unlocks the product. */
477
+ /** @description Sets or retrieves the unlockKey, a unique value required to grant access to the product’s premium features or activate its full functionality. */
478
478
  get unlockKey() {
479
479
  return this.nativeElement ? this.nativeElement.unlockKey : undefined;
480
480
  }
481
481
  set unlockKey(value) {
482
482
  this.nativeElement ? this.nativeElement.unlockKey = value : undefined;
483
483
  }
484
- /** @description Sets or gets the language. Used in conjunction with the property messages. */
484
+ /** @description Specifies or retrieves the current language setting for the component. This property determines which language is used when displaying content from the messages property, allowing for localization and internationalization of displayed messages. Set this property to a supported language code (e.g., "en", "fr") to load the corresponding translations from the messages object. */
485
485
  get locale() {
486
486
  return this.nativeElement ? this.nativeElement.locale : undefined;
487
487
  }
488
488
  set locale(value) {
489
489
  this.nativeElement ? this.nativeElement.locale = value : undefined;
490
490
  }
491
- /** @description Callback used to customize the format of the messages that are returned from the Localization Module. */
491
+ /** @description A callback function that allows you to customize the formatting of messages returned by the Localization Module. Use this callback to modify message text, apply dynamic values, or implement custom formatting logic before the localized messages are delivered to your application. */
492
492
  get localizeFormatFunction() {
493
493
  return this.nativeElement ? this.nativeElement.localizeFormatFunction : undefined;
494
494
  }
495
495
  set localizeFormatFunction(value) {
496
496
  this.nativeElement ? this.nativeElement.localizeFormatFunction = value : undefined;
497
497
  }
498
- /** @description Sets or gets an object specifying strings used in the widget that can be localized. Used in conjunction with the property locale. */
498
+ /** @description Specifies or retrieves an object containing localized string values used within the widget’s user interface. This property enables the customization and translation of UI text for different languages or regions. It is intended to be used together with the locale property, allowing you to easily provide or update localized strings according to the selected locale. */
499
499
  get messages() {
500
500
  return this.nativeElement ? this.nativeElement.messages : undefined;
501
501
  }
502
502
  set messages(value) {
503
503
  this.nativeElement ? this.nativeElement.messages = value : undefined;
504
504
  }
505
- /** @description Determines the minimum number of characters inside the input in order to trigger the autocomplete functionality */
505
+ /** @description Specifies the minimum number of characters a user must enter in the input field before the autocomplete feature is activated and suggestions are displayed. */
506
506
  get minLength() {
507
507
  return this.nativeElement ? this.nativeElement.minLength : undefined;
508
508
  }
509
509
  set minLength(value) {
510
510
  this.nativeElement ? this.nativeElement.minLength = value : undefined;
511
511
  }
512
- /** @description Determines the maximum number of characters inside the input. */
512
+ /** @description Specifies the maximum number of characters that can be entered into the input field. Any additional characters beyond this limit will not be accepted. This helps enforce data validation and consistency for user input. */
513
513
  get maxLength() {
514
514
  return this.nativeElement ? this.nativeElement.maxLength : undefined;
515
515
  }
516
516
  set maxLength(value) {
517
517
  this.nativeElement ? this.nativeElement.maxLength = value : undefined;
518
518
  }
519
- /** @description Sets or gets the name attribute for the element. Name is used when submiting HTML forms. */
519
+ /** @description Sets or retrieves the value of the element's name attribute. The name attribute uniquely identifies form elements when submitting HTML forms, allowing the form data to be organized and accessed by name on the server side. This attribute is essential for grouping form controls and accurately transmitting user input during form submission. */
520
520
  get name() {
521
521
  return this.nativeElement ? this.nativeElement.name : undefined;
522
522
  }
523
523
  set name(value) {
524
524
  this.nativeElement ? this.nativeElement.name = value : undefined;
525
525
  }
526
- /** @description Determines whether the popup is opened or closed */
526
+ /** @description Specifies whether the popup is currently visible (open) or hidden (closed) in the user interface. */
527
527
  get opened() {
528
528
  return this.nativeElement ? this.nativeElement.opened : undefined;
529
529
  }
530
530
  set opened(value) {
531
531
  this.nativeElement ? this.nativeElement.opened = value : undefined;
532
532
  }
533
- /** @description Determines the input's placeholder. */
533
+ /** @description Specifies the placeholder text that appears inside the input field when it is empty, providing guidance or example content to the user. */
534
534
  get placeholder() {
535
535
  return this.nativeElement ? this.nativeElement.placeholder : undefined;
536
536
  }
537
537
  set placeholder(value) {
538
538
  this.nativeElement ? this.nativeElement.placeholder = value : undefined;
539
539
  }
540
- /** @description Disables user interaction with the element. */
540
+ /** @description Prevents any user interactions with the element, including clicking, tapping, selecting, hovering, or focusing. While this is enabled, the element will not respond to mouse, keyboard, or touch events, effectively making it non-interactive for users. */
541
541
  get readonly() {
542
542
  return this.nativeElement ? this.nativeElement.readonly : undefined;
543
543
  }
544
544
  set readonly(value) {
545
545
  this.nativeElement ? this.nativeElement.readonly = value : undefined;
546
546
  }
547
- /** @description Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts. */
547
+ /** @description Specifies or retrieves a value that determines whether the element’s text direction is set to support right-to-left (RTL) languages, such as Arabic or Hebrew. When enabled, the element and its content are aligned according to RTL formatting, ensuring proper display for locales that use right-to-left scripts. */
548
548
  get rightToLeft() {
549
549
  return this.nativeElement ? this.nativeElement.rightToLeft : undefined;
550
550
  }
551
551
  set rightToLeft(value) {
552
552
  this.nativeElement ? this.nativeElement.rightToLeft = value : undefined;
553
553
  }
554
- /** @description Determines whether the resize indicator in the bottom right corner of the drop down is visible or not. This property is used in conjunction with resizeMode. */
554
+ /** @description Controls the visibility of the resize indicator located in the bottom-right corner of the dropdown component. When this property is set to true, users will see a handle allowing them to resize the dropdown area. This property should be used together with the resizeMode property to define both the availability and behavior of the resizing feature. */
555
555
  get resizeIndicator() {
556
556
  return this.nativeElement ? this.nativeElement.resizeIndicator : undefined;
557
557
  }
558
558
  set resizeIndicator(value) {
559
559
  this.nativeElement ? this.nativeElement.resizeIndicator = value : undefined;
560
560
  }
561
- /** @description Determines whether the dropDown can be resized or not. When resizing is enabled, a resize bar appears on the top/bottom side of the drop down. */
561
+ /** @description Specifies whether the drop-down menu is resizable by the user. If resizing is enabled, a resize bar will be displayed along the top or bottom edge of the drop-down, allowing users to click and drag to adjust its height. Disabling this option removes the resize bar and prevents any manual resizing of the drop-down component. */
562
562
  get resizeMode() {
563
563
  return this.nativeElement ? this.nativeElement.resizeMode : undefined;
564
564
  }
565
565
  set resizeMode(value) {
566
566
  this.nativeElement ? this.nativeElement.resizeMode = value : undefined;
567
567
  }
568
- /** @description Determines what will be displayed in the input. */
568
+ /** @description Specifies the content or value that will appear within the input field, either as a default value, user-entered data, or dynamically generated content. This setting controls what the user sees and interacts with inside the input element. */
569
569
  get selectionDisplayMode() {
570
570
  return this.nativeElement ? this.nativeElement.selectionDisplayMode : undefined;
571
571
  }
572
572
  set selectionDisplayMode(value) {
573
573
  this.nativeElement ? this.nativeElement.selectionDisplayMode = value : undefined;
574
574
  }
575
- /** @description Sets or gets the selected indexes. Selected indexes represents an array of the indexes of the items that should be selected. */
575
+ /** @description Sets or retrieves the selected indexes. The selected indexes property is an array containing the numeric indexes of the items that are currently selected. Each value in the array corresponds to the position of a selected item within the overall list or collection. Assigning a new array to this property updates the selection state to match the specified indexes; retrieving it returns the current selection as an array of indexes. */
576
576
  get selectedIndexes() {
577
577
  return this.nativeElement ? this.nativeElement.selectedIndexes : undefined;
578
578
  }
579
579
  set selectedIndexes(value) {
580
580
  this.nativeElement ? this.nativeElement.selectedIndexes = value : undefined;
581
581
  }
582
- /** @description Sets or gets elected indexes. Selected values represents the values of the items that should be selected. */
582
+ /** @description "Sets or retrieves the currently selected indexes. The 'selected' property holds an array of the indices corresponding to the items that are marked as selected. When setting this property, provide an array of indexes to specify which items should be selected. When getting this property, it returns the array of indexes for the currently selected items." */
583
583
  get selectedValues() {
584
584
  return this.nativeElement ? this.nativeElement.selectedValues : undefined;
585
585
  }
586
586
  set selectedValues(value) {
587
587
  this.nativeElement ? this.nativeElement.selectedValues = value : undefined;
588
588
  }
589
- /** @description Determines how many items can be selected. */
589
+ /** @description Specifies the maximum number of items that a user is allowed to select at one time. If this value is set to 1, only single selection is permitted; higher values allow multiple selections up to the defined limit. */
590
590
  get selectionMode() {
591
591
  return this.nativeElement ? this.nativeElement.selectionMode : undefined;
592
592
  }
593
593
  set selectionMode(value) {
594
594
  this.nativeElement ? this.nativeElement.selectionMode = value : undefined;
595
595
  }
596
- /** @description Determines whether the items are sorted alphabetically or not */
596
+ /** @description Specifies whether the items are arranged in alphabetical order. If set to true, the items will be sorted alphabetically; if false, the original order will be preserved. */
597
597
  get sorted() {
598
598
  return this.nativeElement ? this.nativeElement.sorted : undefined;
599
599
  }
600
600
  set sorted(value) {
601
601
  this.nativeElement ? this.nativeElement.sorted = value : undefined;
602
602
  }
603
- /** @description Determines sorting direction - ascending(asc) or descending(desc) */
603
+ /** @description Specifies the sorting order for data, allowing you to choose between ascending ("asc") for lowest-to-highest or alphabetical A–Z sorting, and descending ("desc") for highest-to-lowest or Z–A sorting. */
604
604
  get sortDirection() {
605
605
  return this.nativeElement ? this.nativeElement.sortDirection : undefined;
606
606
  }
607
607
  set sortDirection(value) {
608
608
  this.nativeElement ? this.nativeElement.sortDirection = value : undefined;
609
609
  }
610
- /** @description Determines the theme for the element. Themes define the look of the elements. */
610
+ /** @description Specifies the visual theme to be applied to the element. The selected theme controls the element’s appearance, including colors, fonts, and other stylistic properties, ensuring a consistent look and feel across the user interface. */
611
611
  get theme() {
612
612
  return this.nativeElement ? this.nativeElement.theme : undefined;
613
613
  }
614
614
  set theme(value) {
615
615
  this.nativeElement ? this.nativeElement.theme = value : undefined;
616
616
  }
617
- /** @description Sets a custom content for the tokens when selectionDisplayMode is set to 'tokens'. Tokens are used only for multiple selection. */
617
+ /** @description Defines the custom content to display within each token when the selectionDisplayMode is set to "tokens". Tokens visually represent selected items in a multi-select interface and are only applicable when multiple selection is enabled. Use this option to customize how each token appears, such as displaying specific text, icons, or additional data for each selected item. */
618
618
  get tokenTemplate() {
619
619
  return this.nativeElement ? this.nativeElement.tokenTemplate : undefined;
620
620
  }
621
621
  set tokenTemplate(value) {
622
622
  this.nativeElement ? this.nativeElement.tokenTemplate = value : undefined;
623
623
  }
624
- /** @description If is set to true, the element cannot be focused. */
624
+ /** @description If set to true, the element will not be able to receive keyboard or mouse focus, making it inaccessible via tab navigation or programmatic focus methods. */
625
625
  get unfocusable() {
626
626
  return this.nativeElement ? this.nativeElement.unfocusable : undefined;
627
627
  }
628
628
  set unfocusable(value) {
629
629
  this.nativeElement ? this.nativeElement.unfocusable = value : undefined;
630
630
  }
631
- /** @description Sets or gets the value. */
631
+ /** @description Provides functionality to retrieve (get) or assign (set) the current value of the property. When used as a getter, it returns the property's current value. When used as a setter, it updates the property with the specified value. */
632
632
  get value() {
633
633
  return this.nativeElement ? this.nativeElement.value : undefined;
634
634
  }
635
635
  set value(value) {
636
636
  this.nativeElement ? this.nativeElement.value = value : undefined;
637
637
  }
638
- /** @description Determines the value member of an item. Stored as value in the item object. Similar to groupMember, valueMember is especially usefull when using data from a JSON file as a dataSource for the ListBox and there's a specific property that should be used for the value the items. */
638
+ /** @description Specifies which property of each item object should be used as the value for that item. The value designated by valueMember will be stored in the item's value field. This property functions similarly to groupMember, but is focused on identifying the value rather than the group. valueMember is particularly useful when populating a ListBox from a JSON data source, as it allows you to specify which property of your data objects should serve as the unique value for each item in the ListBox. */
639
639
  get valueMember() {
640
640
  return this.nativeElement ? this.nativeElement.valueMember : undefined;
641
641
  }
642
642
  set valueMember(value) {
643
643
  this.nativeElement ? this.nativeElement.valueMember = value : undefined;
644
644
  }
645
- /** @description Determines the visibility of the vertical scroll bar. */
645
+ /** @description Controls whether the vertical scroll bar is displayed within the content area, allowing users to scroll vertically when the content extends beyond the visible region. */
646
646
  get verticalScrollBarVisibility() {
647
647
  return this.nativeElement ? this.nativeElement.verticalScrollBarVisibility : undefined;
648
648
  }
649
649
  set verticalScrollBarVisibility(value) {
650
650
  this.nativeElement ? this.nativeElement.verticalScrollBarVisibility = value : undefined;
651
651
  }
652
- /** @description Determines weather or not Virtualization is used for the Combo box. Virtualization allows a huge amount of items to be loaded to the List box while preserving the performance. For example a milion items can be loaded to the list box. */
652
+ /** @description Determines whether virtualization is enabled for the ComboBox. When virtualization is enabled, the ComboBox can efficiently display a very large number of items—such as a million—by only rendering the visible items in the ListBox and dynamically loading items as needed. This significantly improves performance and reduces memory usage, especially with large data sets. */
653
653
  get virtualized() {
654
654
  return this.nativeElement ? this.nativeElement.virtualized : undefined;
655
655
  }
656
656
  set virtualized(value) {
657
657
  this.nativeElement ? this.nativeElement.virtualized = value : undefined;
658
658
  }
659
- /** @description Appends a ListItem to the end of the list of items inside element.
659
+ /** @description Appends a new ListItem element to the end of the existing list of items within the specified container element, thereby updating the list to include the newly added item as its last entry.
660
660
  * @param {Node} node. A ListItem element that should be added to the rest of the items as the last item.
661
661
  * @returns {Node}
662
662
  */
@@ -674,7 +674,13 @@ class ComboBoxComponent extends BaseElement {
674
674
  return result;
675
675
  });
676
676
  }
677
- /** @description Adds a new item(s).
677
+ appendChildSync(node) {
678
+ if (this.nativeElement.isRendered) {
679
+ return this.nativeElement.appendChild(node);
680
+ }
681
+ return null;
682
+ }
683
+ /** @description Creates and appends one or more new items to the collection or list.
678
684
  * @param {any} item. Describes the properties of the item that will be inserted. You can also pass an array of items.
679
685
  */
680
686
  add(item) {
@@ -687,7 +693,7 @@ class ComboBoxComponent extends BaseElement {
687
693
  });
688
694
  }
689
695
  }
690
- /** @description Removes all items from the drop down list.
696
+ /** @description Removes all existing items from the dropdown list, resulting in an empty list with no selectable options displayed to the user.
691
697
  */
692
698
  clearItems() {
693
699
  if (this.nativeElement.isRendered) {
@@ -699,7 +705,7 @@ class ComboBoxComponent extends BaseElement {
699
705
  });
700
706
  }
701
707
  }
702
- /** @description Unselects all items.
708
+ /** @description Deselects all currently selected items, ensuring that no items remain selected. This action clears any existing selections and resets the selection state.
703
709
  */
704
710
  clearSelection() {
705
711
  if (this.nativeElement.isRendered) {
@@ -711,7 +717,7 @@ class ComboBoxComponent extends BaseElement {
711
717
  });
712
718
  }
713
719
  }
714
- /** @description Closes the dropDown list.
720
+ /** @description Closes the currently open drop-down list, hiding all available options from view and returning the component to its collapsed state. This action ensures that the drop-down menu is no longer visible to the user.
715
721
  */
716
722
  close() {
717
723
  if (this.nativeElement.isRendered) {
@@ -723,7 +729,7 @@ class ComboBoxComponent extends BaseElement {
723
729
  });
724
730
  }
725
731
  }
726
- /** @description Performs a data bind. This can be used to refresh the data source.
732
+ /** @description Initiates a data binding process, connecting UI components to the underlying data source. This method refreshes the data source, ensuring that any changes made to the data are reflected in the user interface. It can be used to update displayed information after modifying, adding, or deleting data.
727
733
  */
728
734
  dataBind() {
729
735
  if (this.nativeElement.isRendered) {
@@ -735,7 +741,7 @@ class ComboBoxComponent extends BaseElement {
735
741
  });
736
742
  }
737
743
  }
738
- /** @description Ensures the desired item is visible by scrolling to it.
744
+ /** @description Scrolls the target item into view within its container, automatically adjusting the scroll position as needed to make sure the entire item is fully visible to the user.
739
745
  * @param {HTMLElement | string} item. A list item or value of the desired item to be visible.
740
746
  */
741
747
  ensureVisible(item) {
@@ -748,7 +754,7 @@ class ComboBoxComponent extends BaseElement {
748
754
  });
749
755
  }
750
756
  }
751
- /** @description Returns an item instance from the dropDown list.
757
+ /** @description Returns a specific item instance from the dropDown list, allowing you to access the properties and methods of the selected list item. This can be used to retrieve information about the item, such as its value, label, or index within the dropDown.
752
758
  * @param {string} value. The value of an item from the drop down list.
753
759
  * @returns {HTMLElement}
754
760
  */
@@ -766,7 +772,13 @@ class ComboBoxComponent extends BaseElement {
766
772
  return result;
767
773
  });
768
774
  }
769
- /** @description Inserts a new item at a specified position.
775
+ getItemSync(value) {
776
+ if (this.nativeElement.isRendered) {
777
+ return this.nativeElement.getItem(value);
778
+ }
779
+ return null;
780
+ }
781
+ /** @description Inserts a new item into the array at the specified index position, shifting existing elements to the right to accommodate the new item.
770
782
  * @param {number} position. The position where the item must be inserted.
771
783
  * @param {any} item. Describes the properties of the item that will be inserted. You can also pass an array of items.
772
784
  */
@@ -780,7 +792,7 @@ class ComboBoxComponent extends BaseElement {
780
792
  });
781
793
  }
782
794
  }
783
- /** @description Inserts a new ListItem before another in the list.
795
+ /** @description Inserts a new ListItem element directly before a specified existing ListItem within the list, preserving the order of the remaining items.
784
796
  * @param {Node} node. A ListItem element that should be added before the referenceItem in the list.
785
797
  * @param {Node | null} referenceNode. A ListItem element that acts as the reference item before which a new item is about to be inserted. The referenceNode must be in the same list as the node.
786
798
  * @returns {Node}
@@ -799,7 +811,13 @@ class ComboBoxComponent extends BaseElement {
799
811
  return result;
800
812
  });
801
813
  }
802
- /** @description Opens the dropDown list.
814
+ insertBeforeSync(node, referenceNode) {
815
+ if (this.nativeElement.isRendered) {
816
+ return this.nativeElement.insertBefore(node, referenceNode);
817
+ }
818
+ return null;
819
+ }
820
+ /** @description Displays and expands the drop-down list, making all available options visible for selection.
803
821
  */
804
822
  open() {
805
823
  if (this.nativeElement.isRendered) {
@@ -811,7 +829,7 @@ class ComboBoxComponent extends BaseElement {
811
829
  });
812
830
  }
813
831
  }
814
- /** @description Removes an item at a specified position.
832
+ /** @description Removes the item located at the specified index or position within a collection (such as an array or list). After removal, the collection is updated so that subsequent items shift to fill the gap, ensuring contiguous indexing.
815
833
  * @param {number} position. The position of the removed item.
816
834
  */
817
835
  removeAt(position) {
@@ -824,7 +842,7 @@ class ComboBoxComponent extends BaseElement {
824
842
  });
825
843
  }
826
844
  }
827
- /** @description Removes a ListItem from the list of items inside element.
845
+ /** @description Removes a specified ListItem from the collection of items contained within the given element, updating the list to reflect the deletion.
828
846
  * @param {Node} node. A ListItem element that is part of the list of items inside the element.
829
847
  * @returns {Node}
830
848
  */
@@ -842,7 +860,13 @@ class ComboBoxComponent extends BaseElement {
842
860
  return result;
843
861
  });
844
862
  }
845
- /** @description Selects an item from the dropDown list.
863
+ removeChildSync(node) {
864
+ if (this.nativeElement.isRendered) {
865
+ return this.nativeElement.removeChild(node);
866
+ }
867
+ return null;
868
+ }
869
+ /** @description Selects a specified item from the dropdown list, allowing users to choose one option from the available choices. This action updates the dropdown’s current selection and can trigger any associated event handlers or changes in the application’s state.
846
870
  * @param {string | HTMLElement} item. A string, representing the value of the item or an HTML Element referencing an item from the list
847
871
  */
848
872
  select(item) {
@@ -855,7 +879,7 @@ class ComboBoxComponent extends BaseElement {
855
879
  });
856
880
  }
857
881
  }
858
- /** @description Unselects an item from the dropDown list.
882
+ /** @description Deselects a specified item from the dropdown list, removing its selected state and reverting the dropdown to reflect that the item is no longer chosen by the user.
859
883
  * @param {string | HTMLElement} item. A string, representing the value of the item or an HTML Element referencing an item from the list
860
884
  */
861
885
  unselect(item) {
@@ -868,7 +892,7 @@ class ComboBoxComponent extends BaseElement {
868
892
  });
869
893
  }
870
894
  }
871
- /** @description Updates an item from the dropDown list.
895
+ /** @description Updates the selected item in the dropDown list with new data or attributes. This action modifies the existing item rather than adding or removing items from the list, ensuring that any changes are reflected immediately in the user interface. Specify the target item and the updated values to complete the operation.
872
896
  * @param {number} position. The position where the item must be updated.
873
897
  * @param {any} value. The value of the updated item.
874
898
  */