@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.
- package/combobox/smart.combobox.d.ts +96 -92
- package/esm2020/combobox/smart.combobox.mjs +117 -93
- package/fesm2015/smart-webcomponents-angular-combobox.mjs +116 -92
- package/fesm2015/smart-webcomponents-angular-combobox.mjs.map +1 -1
- package/fesm2020/smart-webcomponents-angular-combobox.mjs +116 -92
- package/fesm2020/smart-webcomponents-angular-combobox.mjs.map +1 -1
- package/index.d.ts +5656 -5320
- package/package.json +1 -1
- package/source/modules/smart.combobox.js +2 -2
- package/source/smart.button.js +2 -2
- package/source/smart.checkbox.js +2 -2
- package/source/smart.combobox.js +2 -2
- package/source/smart.dropdownlist.js +2 -2
- package/source/smart.element.js +2 -2
- package/source/smart.listbox.js +2 -2
- package/source/smart.radiobutton.js +2 -2
- package/source/smart.scrollbar.js +1 -1
- package/styles/smart.base.css +1 -1
- package/styles/smart.combobox.css +1 -1
|
@@ -25,109 +25,109 @@ export declare class ComboBoxComponent extends BaseElement implements OnInit, Af
|
|
|
25
25
|
* The registered callback function called when a blur event occurs on the form elements.
|
|
26
26
|
*/
|
|
27
27
|
_onTouched: () => any;
|
|
28
|
-
/** @description
|
|
28
|
+
/** @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. */
|
|
29
29
|
get autoCloseDelay(): number;
|
|
30
30
|
set autoCloseDelay(value: number);
|
|
31
|
-
/** @description
|
|
31
|
+
/** @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. */
|
|
32
32
|
get autoComplete(): AutoComplete | string;
|
|
33
33
|
set autoComplete(value: AutoComplete | string);
|
|
34
|
-
/** @description
|
|
34
|
+
/** @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. */
|
|
35
35
|
get autoCompleteDelay(): number;
|
|
36
36
|
set autoCompleteDelay(value: number);
|
|
37
|
-
/** @description
|
|
37
|
+
/** @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. */
|
|
38
38
|
get autoOpenShortcutKey(): string[];
|
|
39
39
|
set autoOpenShortcutKey(value: string[]);
|
|
40
|
-
/** @description
|
|
40
|
+
/** @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. */
|
|
41
41
|
get dataSource(): any;
|
|
42
42
|
set dataSource(value: any);
|
|
43
|
-
/** @description
|
|
43
|
+
/** @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. */
|
|
44
44
|
get disabled(): boolean;
|
|
45
45
|
set disabled(value: boolean);
|
|
46
|
-
/** @description
|
|
46
|
+
/** @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. */
|
|
47
47
|
get displayLoadingIndicator(): boolean;
|
|
48
48
|
set displayLoadingIndicator(value: boolean);
|
|
49
|
-
/** @description Sets or
|
|
49
|
+
/** @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. */
|
|
50
50
|
get displayMember(): string;
|
|
51
51
|
set displayMember(value: string);
|
|
52
|
-
/** @description
|
|
52
|
+
/** @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. */
|
|
53
53
|
get dropDownAppendTo(): string;
|
|
54
54
|
set dropDownAppendTo(value: string);
|
|
55
|
-
/** @description
|
|
55
|
+
/** @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. */
|
|
56
56
|
get dropDownButtonPosition(): DropDownButtonPosition | string;
|
|
57
57
|
set dropDownButtonPosition(value: DropDownButtonPosition | string);
|
|
58
|
-
/** @description
|
|
58
|
+
/** @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. */
|
|
59
59
|
get dropDownHeight(): string | number;
|
|
60
60
|
set dropDownHeight(value: string | number);
|
|
61
|
-
/** @description
|
|
61
|
+
/** @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. */
|
|
62
62
|
get dropDownMaxHeight(): string | number;
|
|
63
63
|
set dropDownMaxHeight(value: string | number);
|
|
64
|
-
/** @description
|
|
64
|
+
/** @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. */
|
|
65
65
|
get dropDownMaxWidth(): string | number;
|
|
66
66
|
set dropDownMaxWidth(value: string | number);
|
|
67
|
-
/** @description
|
|
67
|
+
/** @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. */
|
|
68
68
|
get dropDownMinHeight(): string | number;
|
|
69
69
|
set dropDownMinHeight(value: string | number);
|
|
70
|
-
/** @description
|
|
70
|
+
/** @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. */
|
|
71
71
|
get dropDownMinWidth(): string | number;
|
|
72
72
|
set dropDownMinWidth(value: string | number);
|
|
73
|
-
/** @description
|
|
73
|
+
/** @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. */
|
|
74
74
|
get dropDownOpenMode(): DropDownOpenMode | string;
|
|
75
75
|
set dropDownOpenMode(value: DropDownOpenMode | string);
|
|
76
|
-
/** @description If this property is enabled,
|
|
76
|
+
/** @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. */
|
|
77
77
|
get dropDownOverlay(): boolean;
|
|
78
78
|
set dropDownOverlay(value: boolean);
|
|
79
|
-
/** @description
|
|
79
|
+
/** @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. */
|
|
80
80
|
get dropDownPlaceholder(): string;
|
|
81
81
|
set dropDownPlaceholder(value: string);
|
|
82
|
-
/** @description
|
|
82
|
+
/** @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. */
|
|
83
83
|
get dropDownPosition(): DropDownPosition | string;
|
|
84
84
|
set dropDownPosition(value: DropDownPosition | string);
|
|
85
|
-
/** @description
|
|
85
|
+
/** @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. */
|
|
86
86
|
get dropDownWidth(): string | number;
|
|
87
87
|
set dropDownWidth(value: string | number);
|
|
88
|
-
/** @description
|
|
88
|
+
/** @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. */
|
|
89
89
|
get escKeyMode(): ComboBoxEscKeyMode | string;
|
|
90
90
|
set escKeyMode(value: ComboBoxEscKeyMode | string);
|
|
91
|
-
/** @description
|
|
91
|
+
/** @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. */
|
|
92
92
|
get filterable(): boolean;
|
|
93
93
|
set filterable(value: boolean);
|
|
94
|
-
/** @description
|
|
94
|
+
/** @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. */
|
|
95
95
|
get filterInputPlaceholder(): string;
|
|
96
96
|
set filterInputPlaceholder(value: string);
|
|
97
|
-
/** @description
|
|
97
|
+
/** @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. */
|
|
98
98
|
get filterMode(): FilterMode | string;
|
|
99
99
|
set filterMode(value: FilterMode | string);
|
|
100
|
-
/** @description
|
|
100
|
+
/** @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. */
|
|
101
101
|
get grouped(): boolean;
|
|
102
102
|
set grouped(value: boolean);
|
|
103
|
-
/** @description
|
|
103
|
+
/** @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. */
|
|
104
104
|
get groupMember(): string;
|
|
105
105
|
set groupMember(value: string);
|
|
106
|
-
/** @description
|
|
106
|
+
/** @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. */
|
|
107
107
|
get hint(): string;
|
|
108
108
|
set hint(value: string);
|
|
109
|
-
/** @description
|
|
109
|
+
/** @description Controls whether the horizontal scroll bar is displayed within the dropdown menu when the content exceeds the available width. */
|
|
110
110
|
get horizontalScrollBarVisibility(): HorizontalScrollBarVisibility | string;
|
|
111
111
|
set horizontalScrollBarVisibility(value: HorizontalScrollBarVisibility | string);
|
|
112
|
-
/** @description Represents the property name of a List item
|
|
112
|
+
/** @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. */
|
|
113
113
|
get inputMember(): string;
|
|
114
114
|
set inputMember(value: string);
|
|
115
|
-
/** @description
|
|
115
|
+
/** @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. */
|
|
116
116
|
get inputPurpose(): string;
|
|
117
117
|
set inputPurpose(value: string);
|
|
118
|
-
/** @description IncrementalSearchDelay property
|
|
118
|
+
/** @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. */
|
|
119
119
|
get incrementalSearchDelay(): number;
|
|
120
120
|
set incrementalSearchDelay(value: number);
|
|
121
|
-
/** @description
|
|
121
|
+
/** @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. */
|
|
122
122
|
get incrementalSearchMode(): SearchMode | string;
|
|
123
123
|
set incrementalSearchMode(value: SearchMode | string);
|
|
124
|
-
/** @description
|
|
124
|
+
/** @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. */
|
|
125
125
|
get itemHeight(): number;
|
|
126
126
|
set itemHeight(value: number);
|
|
127
|
-
/** @description
|
|
127
|
+
/** @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. */
|
|
128
128
|
get itemMeasureMode(): ListItemMeasureMode | string;
|
|
129
129
|
set itemMeasureMode(value: ListItemMeasureMode | string);
|
|
130
|
-
/** @description A getter that returns an array
|
|
130
|
+
/** @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. */
|
|
131
131
|
get items(): {
|
|
132
132
|
label: string;
|
|
133
133
|
value: string;
|
|
@@ -136,97 +136,97 @@ export declare class ComboBoxComponent extends BaseElement implements OnInit, Af
|
|
|
136
136
|
label: string;
|
|
137
137
|
value: string;
|
|
138
138
|
}[]);
|
|
139
|
-
/** @description The itemTemplate property is a string that
|
|
139
|
+
/** @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. */
|
|
140
140
|
get itemTemplate(): any;
|
|
141
141
|
set itemTemplate(value: any);
|
|
142
|
-
/** @description
|
|
142
|
+
/** @description Displays a small text label positioned above the element, typically used to provide context, instructions, or additional information to users. */
|
|
143
143
|
get label(): string;
|
|
144
144
|
set label(value: string);
|
|
145
|
-
/** @description
|
|
145
|
+
/** @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. */
|
|
146
146
|
get loadingIndicatorPlaceholder(): string;
|
|
147
147
|
set loadingIndicatorPlaceholder(value: string);
|
|
148
|
-
/** @description
|
|
148
|
+
/** @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. */
|
|
149
149
|
get loadingIndicatorPosition(): VerticalAlignment | string;
|
|
150
150
|
set loadingIndicatorPosition(value: VerticalAlignment | string);
|
|
151
|
-
/** @description Sets or
|
|
151
|
+
/** @description Sets or retrieves the unlockKey, a unique value required to grant access to the product’s premium features or activate its full functionality. */
|
|
152
152
|
get unlockKey(): string;
|
|
153
153
|
set unlockKey(value: string);
|
|
154
|
-
/** @description
|
|
154
|
+
/** @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. */
|
|
155
155
|
get locale(): string;
|
|
156
156
|
set locale(value: string);
|
|
157
|
-
/** @description
|
|
157
|
+
/** @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. */
|
|
158
158
|
get localizeFormatFunction(): any;
|
|
159
159
|
set localizeFormatFunction(value: any);
|
|
160
|
-
/** @description
|
|
160
|
+
/** @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. */
|
|
161
161
|
get messages(): any;
|
|
162
162
|
set messages(value: any);
|
|
163
|
-
/** @description
|
|
163
|
+
/** @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. */
|
|
164
164
|
get minLength(): number;
|
|
165
165
|
set minLength(value: number);
|
|
166
|
-
/** @description
|
|
166
|
+
/** @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. */
|
|
167
167
|
get maxLength(): number;
|
|
168
168
|
set maxLength(value: number);
|
|
169
|
-
/** @description Sets or
|
|
169
|
+
/** @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. */
|
|
170
170
|
get name(): string;
|
|
171
171
|
set name(value: string);
|
|
172
|
-
/** @description
|
|
172
|
+
/** @description Specifies whether the popup is currently visible (open) or hidden (closed) in the user interface. */
|
|
173
173
|
get opened(): boolean;
|
|
174
174
|
set opened(value: boolean);
|
|
175
|
-
/** @description
|
|
175
|
+
/** @description Specifies the placeholder text that appears inside the input field when it is empty, providing guidance or example content to the user. */
|
|
176
176
|
get placeholder(): string;
|
|
177
177
|
set placeholder(value: string);
|
|
178
|
-
/** @description
|
|
178
|
+
/** @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. */
|
|
179
179
|
get readonly(): boolean;
|
|
180
180
|
set readonly(value: boolean);
|
|
181
|
-
/** @description
|
|
181
|
+
/** @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. */
|
|
182
182
|
get rightToLeft(): boolean;
|
|
183
183
|
set rightToLeft(value: boolean);
|
|
184
|
-
/** @description
|
|
184
|
+
/** @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. */
|
|
185
185
|
get resizeIndicator(): boolean;
|
|
186
186
|
set resizeIndicator(value: boolean);
|
|
187
|
-
/** @description
|
|
187
|
+
/** @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. */
|
|
188
188
|
get resizeMode(): ResizeMode | string;
|
|
189
189
|
set resizeMode(value: ResizeMode | string);
|
|
190
|
-
/** @description
|
|
190
|
+
/** @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. */
|
|
191
191
|
get selectionDisplayMode(): SelectionDisplayMode | string;
|
|
192
192
|
set selectionDisplayMode(value: SelectionDisplayMode | string);
|
|
193
|
-
/** @description Sets or
|
|
193
|
+
/** @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. */
|
|
194
194
|
get selectedIndexes(): number[];
|
|
195
195
|
set selectedIndexes(value: number[]);
|
|
196
|
-
/** @description
|
|
196
|
+
/** @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." */
|
|
197
197
|
get selectedValues(): string[];
|
|
198
198
|
set selectedValues(value: string[]);
|
|
199
|
-
/** @description
|
|
199
|
+
/** @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. */
|
|
200
200
|
get selectionMode(): ListSelectionMode | string;
|
|
201
201
|
set selectionMode(value: ListSelectionMode | string);
|
|
202
|
-
/** @description
|
|
202
|
+
/** @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. */
|
|
203
203
|
get sorted(): boolean;
|
|
204
204
|
set sorted(value: boolean);
|
|
205
|
-
/** @description
|
|
205
|
+
/** @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. */
|
|
206
206
|
get sortDirection(): string;
|
|
207
207
|
set sortDirection(value: string);
|
|
208
|
-
/** @description
|
|
208
|
+
/** @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. */
|
|
209
209
|
get theme(): string;
|
|
210
210
|
set theme(value: string);
|
|
211
|
-
/** @description
|
|
211
|
+
/** @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. */
|
|
212
212
|
get tokenTemplate(): any;
|
|
213
213
|
set tokenTemplate(value: any);
|
|
214
|
-
/** @description If
|
|
214
|
+
/** @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. */
|
|
215
215
|
get unfocusable(): boolean;
|
|
216
216
|
set unfocusable(value: boolean);
|
|
217
|
-
/** @description
|
|
217
|
+
/** @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. */
|
|
218
218
|
get value(): string;
|
|
219
219
|
set value(value: string);
|
|
220
|
-
/** @description
|
|
220
|
+
/** @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. */
|
|
221
221
|
get valueMember(): string;
|
|
222
222
|
set valueMember(value: string);
|
|
223
|
-
/** @description
|
|
223
|
+
/** @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. */
|
|
224
224
|
get verticalScrollBarVisibility(): VerticalScrollBarVisibility | string;
|
|
225
225
|
set verticalScrollBarVisibility(value: VerticalScrollBarVisibility | string);
|
|
226
|
-
/** @description Determines
|
|
226
|
+
/** @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. */
|
|
227
227
|
get virtualized(): boolean;
|
|
228
228
|
set virtualized(value: boolean);
|
|
229
|
-
/** @description This event is triggered
|
|
229
|
+
/** @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.
|
|
230
230
|
* @param event. The custom event. Custom event was created with: event.detail( addedItems, disabled, index, label, removedItems, selected, value)
|
|
231
231
|
* addedItems - An array of List items that have been selected.
|
|
232
232
|
* disabled - A flag indicating whether or not the item that caused the change event is disabled.
|
|
@@ -237,13 +237,13 @@ export declare class ComboBoxComponent extends BaseElement implements OnInit, Af
|
|
|
237
237
|
* value - The value of the List item that triggered the event.
|
|
238
238
|
*/
|
|
239
239
|
onChange: EventEmitter<CustomEvent>;
|
|
240
|
-
/** @description This event is triggered when the drop
|
|
240
|
+
/** @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.
|
|
241
241
|
* @param event. The custom event. */
|
|
242
242
|
onClose: EventEmitter<CustomEvent>;
|
|
243
|
-
/** @description This event is triggered
|
|
243
|
+
/** @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.
|
|
244
244
|
* @param event. The custom event. */
|
|
245
245
|
onClosing: EventEmitter<CustomEvent>;
|
|
246
|
-
/** @description This event is triggered
|
|
246
|
+
/** @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.
|
|
247
247
|
* @param event. The custom event. Custom event was created with: event.detail( disabled, index, label, selected, value)
|
|
248
248
|
* disabled - Indicates whether the List item that was clicked is disabled or not.
|
|
249
249
|
* index - Indicates the index of the List item that was clicked.
|
|
@@ -252,93 +252,97 @@ export declare class ComboBoxComponent extends BaseElement implements OnInit, Af
|
|
|
252
252
|
* value - The value of the List item that was clicked.
|
|
253
253
|
*/
|
|
254
254
|
onItemClick: EventEmitter<CustomEvent>;
|
|
255
|
-
/** @description This event is triggered when the
|
|
255
|
+
/** @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.
|
|
256
256
|
* @param event. The custom event. */
|
|
257
257
|
onOpen: EventEmitter<CustomEvent>;
|
|
258
|
-
/** @description This event is triggered
|
|
258
|
+
/** @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.
|
|
259
259
|
* @param event. The custom event. */
|
|
260
260
|
onOpening: EventEmitter<CustomEvent>;
|
|
261
|
-
/** @description This event is triggered when user
|
|
261
|
+
/** @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.
|
|
262
262
|
* @param event. The custom event. Custom event was created with: event.detail( position)
|
|
263
263
|
* position - An object containing the current left and top positions of the drop down.
|
|
264
264
|
*/
|
|
265
265
|
onResizeStart: EventEmitter<CustomEvent>;
|
|
266
|
-
/** @description This event is triggered
|
|
266
|
+
/** @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.
|
|
267
267
|
* @param event. The custom event. Custom event was created with: event.detail( position)
|
|
268
268
|
* position - An object containing the current left and top positions of the drop down.
|
|
269
269
|
*/
|
|
270
270
|
onResizeEnd: EventEmitter<CustomEvent>;
|
|
271
|
-
/** @description This event is triggered when user scrolls to the
|
|
271
|
+
/** @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.
|
|
272
272
|
* @param event. The custom event. */
|
|
273
273
|
onScrollBottomReached: EventEmitter<CustomEvent>;
|
|
274
|
-
/** @description This event is triggered when user scrolls to the
|
|
274
|
+
/** @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.
|
|
275
275
|
* @param event. The custom event. */
|
|
276
276
|
onScrollTopReached: EventEmitter<CustomEvent>;
|
|
277
|
-
/** @description This event is triggered when a token item(pill)
|
|
277
|
+
/** @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."
|
|
278
278
|
* @param event. The custom event. */
|
|
279
279
|
onTokenClick: EventEmitter<CustomEvent>;
|
|
280
|
-
/** @description Appends a ListItem to the end of the list of items
|
|
280
|
+
/** @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.
|
|
281
281
|
* @param {Node} node. A ListItem element that should be added to the rest of the items as the last item.
|
|
282
282
|
* @returns {Node}
|
|
283
283
|
*/
|
|
284
284
|
appendChild(node: any): Promise<any>;
|
|
285
|
-
|
|
285
|
+
appendChildSync(node: any): Node;
|
|
286
|
+
/** @description Creates and appends one or more new items to the collection or list.
|
|
286
287
|
* @param {any} item. Describes the properties of the item that will be inserted. You can also pass an array of items.
|
|
287
288
|
*/
|
|
288
289
|
add(item: any): void;
|
|
289
|
-
/** @description Removes all items from the
|
|
290
|
+
/** @description Removes all existing items from the dropdown list, resulting in an empty list with no selectable options displayed to the user.
|
|
290
291
|
*/
|
|
291
292
|
clearItems(): void;
|
|
292
|
-
/** @description
|
|
293
|
+
/** @description Deselects all currently selected items, ensuring that no items remain selected. This action clears any existing selections and resets the selection state.
|
|
293
294
|
*/
|
|
294
295
|
clearSelection(): void;
|
|
295
|
-
/** @description Closes the
|
|
296
|
+
/** @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.
|
|
296
297
|
*/
|
|
297
298
|
close(): void;
|
|
298
|
-
/** @description
|
|
299
|
+
/** @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.
|
|
299
300
|
*/
|
|
300
301
|
dataBind(): void;
|
|
301
|
-
/** @description
|
|
302
|
+
/** @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.
|
|
302
303
|
* @param {HTMLElement | string} item. A list item or value of the desired item to be visible.
|
|
303
304
|
*/
|
|
304
305
|
ensureVisible(item: HTMLElement | string): void;
|
|
305
|
-
/** @description Returns
|
|
306
|
+
/** @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.
|
|
306
307
|
* @param {string} value. The value of an item from the drop down list.
|
|
307
308
|
* @returns {HTMLElement}
|
|
308
309
|
*/
|
|
309
310
|
getItem(value: any): Promise<any>;
|
|
310
|
-
|
|
311
|
+
getItemSync(value: any): HTMLElement;
|
|
312
|
+
/** @description Inserts a new item into the array at the specified index position, shifting existing elements to the right to accommodate the new item.
|
|
311
313
|
* @param {number} position. The position where the item must be inserted.
|
|
312
314
|
* @param {any} item. Describes the properties of the item that will be inserted. You can also pass an array of items.
|
|
313
315
|
*/
|
|
314
316
|
insert(position: number, item: any): void;
|
|
315
|
-
/** @description Inserts a new ListItem before
|
|
317
|
+
/** @description Inserts a new ListItem element directly before a specified existing ListItem within the list, preserving the order of the remaining items.
|
|
316
318
|
* @param {Node} node. A ListItem element that should be added before the referenceItem in the list.
|
|
317
319
|
* @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.
|
|
318
320
|
* @returns {Node}
|
|
319
321
|
*/
|
|
320
322
|
insertBefore(node: any, referenceNode: any): Promise<any>;
|
|
321
|
-
|
|
323
|
+
insertBeforeSync(node: any, referenceNode: any): Node;
|
|
324
|
+
/** @description Displays and expands the drop-down list, making all available options visible for selection.
|
|
322
325
|
*/
|
|
323
326
|
open(): void;
|
|
324
|
-
/** @description Removes
|
|
327
|
+
/** @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.
|
|
325
328
|
* @param {number} position. The position of the removed item.
|
|
326
329
|
*/
|
|
327
330
|
removeAt(position: number): void;
|
|
328
|
-
/** @description Removes a ListItem from the
|
|
331
|
+
/** @description Removes a specified ListItem from the collection of items contained within the given element, updating the list to reflect the deletion.
|
|
329
332
|
* @param {Node} node. A ListItem element that is part of the list of items inside the element.
|
|
330
333
|
* @returns {Node}
|
|
331
334
|
*/
|
|
332
335
|
removeChild(node: any): Promise<any>;
|
|
333
|
-
|
|
336
|
+
removeChildSync(node: any): Node;
|
|
337
|
+
/** @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.
|
|
334
338
|
* @param {string | HTMLElement} item. A string, representing the value of the item or an HTML Element referencing an item from the list
|
|
335
339
|
*/
|
|
336
340
|
select(item: string | HTMLElement): void;
|
|
337
|
-
/** @description
|
|
341
|
+
/** @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.
|
|
338
342
|
* @param {string | HTMLElement} item. A string, representing the value of the item or an HTML Element referencing an item from the list
|
|
339
343
|
*/
|
|
340
344
|
unselect(item: string | HTMLElement): void;
|
|
341
|
-
/** @description Updates
|
|
345
|
+
/** @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.
|
|
342
346
|
* @param {number} position. The position where the item must be updated.
|
|
343
347
|
* @param {any} value. The value of the updated item.
|
|
344
348
|
*/
|