@smart-webcomponents-angular/combobox 19.0.8 → 25.0.0
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 +99 -92
- package/combobox/smart.element.d.ts +6 -2
- package/esm2020/combobox/smart.combobox.mjs +130 -95
- package/esm2020/combobox/smart.element.mjs +16 -3
- package/esm2020/combobox/smart.listitem.mjs +3 -2
- package/esm2020/combobox/smart.listitemsgroup.mjs +3 -2
- package/fesm2015/smart-webcomponents-angular-combobox.mjs +147 -98
- package/fesm2015/smart-webcomponents-angular-combobox.mjs.map +1 -1
- package/fesm2020/smart-webcomponents-angular-combobox.mjs +147 -98
- package/fesm2020/smart-webcomponents-angular-combobox.mjs.map +1 -1
- package/index.d.ts +5986 -5196
- package/package.json +20 -17
- package/source/modules/smart.combobox.js +2 -2
- package/source/smart.button.js +3 -3
- package/source/smart.checkbox.js +3 -3
- package/source/smart.combobox.js +3 -3
- package/source/smart.dropdownlist.js +3 -3
- package/source/smart.element.js +3 -3
- package/source/smart.listbox.js +3 -3
- package/source/smart.radiobutton.js +3 -3
- package/source/smart.scrollbar.js +2 -2
- package/styles/font/smart-icons.eot +0 -0
- package/styles/font/smart-icons.svg +14 -0
- package/styles/font/smart-icons.ttf +0 -0
- package/styles/font/smart-icons.woff +0 -0
- package/styles/font/smart-icons.woff2 +0 -0
- package/styles/smart.base.css +2 -2
- package/styles/smart.combobox.css +1 -1
- package/styles/smart.common.css +1 -1
|
@@ -45,6 +45,13 @@ class BaseElement {
|
|
|
45
45
|
focus(options) {
|
|
46
46
|
this.nativeElement.focus(options);
|
|
47
47
|
}
|
|
48
|
+
/** @description Sets or gets the license. */
|
|
49
|
+
get license() {
|
|
50
|
+
return this.nativeElement ? this.nativeElement.license : undefined;
|
|
51
|
+
}
|
|
52
|
+
set license(value) {
|
|
53
|
+
this.nativeElement ? this.nativeElement.license = value : undefined;
|
|
54
|
+
}
|
|
48
55
|
/** @description Sets or gets the language. Used in conjunction with the property messages. */
|
|
49
56
|
get locale() {
|
|
50
57
|
return this.nativeElement ? this.nativeElement.locale : undefined;
|
|
@@ -82,7 +89,7 @@ class BaseElement {
|
|
|
82
89
|
}
|
|
83
90
|
}
|
|
84
91
|
BaseElement.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "13.2.6", ngImport: i0, type: BaseElement, deps: [{ token: i0.ElementRef }], target: i0.ɵɵFactoryTarget.Directive });
|
|
85
|
-
BaseElement.ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "12.0.0", version: "13.2.6", type: BaseElement, inputs: { locale: "locale", localizeFormatFunction: "localizeFormatFunction", messages: "messages", rightToLeft: "rightToLeft", theme: "theme" }, outputs: { onCreate: "onCreate", onReady: "onReady", onAttach: "onAttach", onDetach: "onDetach" }, ngImport: i0 });
|
|
92
|
+
BaseElement.ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "12.0.0", version: "13.2.6", type: BaseElement, inputs: { license: "license", locale: "locale", localizeFormatFunction: "localizeFormatFunction", messages: "messages", rightToLeft: "rightToLeft", theme: "theme" }, outputs: { onCreate: "onCreate", onReady: "onReady", onAttach: "onAttach", onDetach: "onDetach" }, ngImport: i0 });
|
|
86
93
|
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.2.6", ngImport: i0, type: BaseElement, decorators: [{
|
|
87
94
|
type: Directive
|
|
88
95
|
}], ctorParameters: function () { return [{ type: i0.ElementRef }]; }, propDecorators: { onCreate: [{
|
|
@@ -93,6 +100,8 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.2.6", ngImpor
|
|
|
93
100
|
type: Output
|
|
94
101
|
}], onDetach: [{
|
|
95
102
|
type: Output
|
|
103
|
+
}], license: [{
|
|
104
|
+
type: Input
|
|
96
105
|
}], locale: [{
|
|
97
106
|
type: Input
|
|
98
107
|
}], localizeFormatFunction: [{
|
|
@@ -104,7 +113,10 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.2.6", ngImpor
|
|
|
104
113
|
}], theme: [{
|
|
105
114
|
type: Input
|
|
106
115
|
}] } });
|
|
107
|
-
|
|
116
|
+
let Smart;
|
|
117
|
+
if (typeof window !== "undefined") {
|
|
118
|
+
Smart = window.Smart;
|
|
119
|
+
}
|
|
108
120
|
|
|
109
121
|
const CUSTOM_INPUT_CONTROL_VALUE_ACCESSOR = {
|
|
110
122
|
provide: NG_VALUE_ACCESSOR,
|
|
@@ -125,7 +137,7 @@ class ComboBoxComponent extends BaseElement {
|
|
|
125
137
|
* The registered callback function called when a blur event occurs on the form elements.
|
|
126
138
|
*/
|
|
127
139
|
this._onTouched = () => { };
|
|
128
|
-
/** @description This event is triggered
|
|
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.
|
|
129
141
|
* @param event. The custom event. Custom event was created with: event.detail( addedItems, disabled, index, label, removedItems, selected, value)
|
|
130
142
|
* addedItems - An array of List items that have been selected.
|
|
131
143
|
* disabled - A flag indicating whether or not the item that caused the change event is disabled.
|
|
@@ -136,13 +148,13 @@ class ComboBoxComponent extends BaseElement {
|
|
|
136
148
|
* value - The value of the List item that triggered the event.
|
|
137
149
|
*/
|
|
138
150
|
this.onChange = new EventEmitter();
|
|
139
|
-
/** @description This event is triggered when the drop
|
|
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.
|
|
140
152
|
* @param event. The custom event. */
|
|
141
153
|
this.onClose = new EventEmitter();
|
|
142
|
-
/** @description This event is triggered
|
|
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.
|
|
143
155
|
* @param event. The custom event. */
|
|
144
156
|
this.onClosing = new EventEmitter();
|
|
145
|
-
/** @description This event is triggered
|
|
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.
|
|
146
158
|
* @param event. The custom event. Custom event was created with: event.detail( disabled, index, label, selected, value)
|
|
147
159
|
* disabled - Indicates whether the List item that was clicked is disabled or not.
|
|
148
160
|
* index - Indicates the index of the List item that was clicked.
|
|
@@ -151,29 +163,29 @@ class ComboBoxComponent extends BaseElement {
|
|
|
151
163
|
* value - The value of the List item that was clicked.
|
|
152
164
|
*/
|
|
153
165
|
this.onItemClick = new EventEmitter();
|
|
154
|
-
/** @description This event is triggered when the
|
|
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.
|
|
155
167
|
* @param event. The custom event. */
|
|
156
168
|
this.onOpen = new EventEmitter();
|
|
157
|
-
/** @description This event is triggered
|
|
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.
|
|
158
170
|
* @param event. The custom event. */
|
|
159
171
|
this.onOpening = new EventEmitter();
|
|
160
|
-
/** @description This event is triggered when user
|
|
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.
|
|
161
173
|
* @param event. The custom event. Custom event was created with: event.detail( position)
|
|
162
174
|
* position - An object containing the current left and top positions of the drop down.
|
|
163
175
|
*/
|
|
164
176
|
this.onResizeStart = new EventEmitter();
|
|
165
|
-
/** @description This event is triggered
|
|
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.
|
|
166
178
|
* @param event. The custom event. Custom event was created with: event.detail( position)
|
|
167
179
|
* position - An object containing the current left and top positions of the drop down.
|
|
168
180
|
*/
|
|
169
181
|
this.onResizeEnd = new EventEmitter();
|
|
170
|
-
/** @description This event is triggered when user scrolls to the
|
|
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.
|
|
171
183
|
* @param event. The custom event. */
|
|
172
184
|
this.onScrollBottomReached = new EventEmitter();
|
|
173
|
-
/** @description This event is triggered when user scrolls to the
|
|
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.
|
|
174
186
|
* @param event. The custom event. */
|
|
175
187
|
this.onScrollTopReached = new EventEmitter();
|
|
176
|
-
/** @description This event is triggered when a token item(pill)
|
|
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."
|
|
177
189
|
* @param event. The custom event. */
|
|
178
190
|
this.onTokenClick = new EventEmitter();
|
|
179
191
|
this._initialChange = true;
|
|
@@ -189,455 +201,462 @@ class ComboBoxComponent extends BaseElement {
|
|
|
189
201
|
}
|
|
190
202
|
return this.nativeElement;
|
|
191
203
|
}
|
|
192
|
-
/** @description
|
|
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. */
|
|
193
205
|
get autoCloseDelay() {
|
|
194
206
|
return this.nativeElement ? this.nativeElement.autoCloseDelay : undefined;
|
|
195
207
|
}
|
|
196
208
|
set autoCloseDelay(value) {
|
|
197
209
|
this.nativeElement ? this.nativeElement.autoCloseDelay = value : undefined;
|
|
198
210
|
}
|
|
199
|
-
/** @description
|
|
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. */
|
|
200
212
|
get autoComplete() {
|
|
201
213
|
return this.nativeElement ? this.nativeElement.autoComplete : undefined;
|
|
202
214
|
}
|
|
203
215
|
set autoComplete(value) {
|
|
204
216
|
this.nativeElement ? this.nativeElement.autoComplete = value : undefined;
|
|
205
217
|
}
|
|
206
|
-
/** @description
|
|
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. */
|
|
207
219
|
get autoCompleteDelay() {
|
|
208
220
|
return this.nativeElement ? this.nativeElement.autoCompleteDelay : undefined;
|
|
209
221
|
}
|
|
210
222
|
set autoCompleteDelay(value) {
|
|
211
223
|
this.nativeElement ? this.nativeElement.autoCompleteDelay = value : undefined;
|
|
212
224
|
}
|
|
213
|
-
/** @description
|
|
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. */
|
|
214
226
|
get autoOpenShortcutKey() {
|
|
215
227
|
return this.nativeElement ? this.nativeElement.autoOpenShortcutKey : undefined;
|
|
216
228
|
}
|
|
217
229
|
set autoOpenShortcutKey(value) {
|
|
218
230
|
this.nativeElement ? this.nativeElement.autoOpenShortcutKey = value : undefined;
|
|
219
231
|
}
|
|
220
|
-
/** @description
|
|
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. */
|
|
221
233
|
get dataSource() {
|
|
222
234
|
return this.nativeElement ? this.nativeElement.dataSource : undefined;
|
|
223
235
|
}
|
|
224
236
|
set dataSource(value) {
|
|
225
237
|
this.nativeElement ? this.nativeElement.dataSource = value : undefined;
|
|
226
238
|
}
|
|
227
|
-
/** @description
|
|
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. */
|
|
228
240
|
get disabled() {
|
|
229
241
|
return this.nativeElement ? this.nativeElement.disabled : undefined;
|
|
230
242
|
}
|
|
231
243
|
set disabled(value) {
|
|
232
244
|
this.nativeElement ? this.nativeElement.disabled = value : undefined;
|
|
233
245
|
}
|
|
234
|
-
/** @description
|
|
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. */
|
|
235
247
|
get displayLoadingIndicator() {
|
|
236
248
|
return this.nativeElement ? this.nativeElement.displayLoadingIndicator : undefined;
|
|
237
249
|
}
|
|
238
250
|
set displayLoadingIndicator(value) {
|
|
239
251
|
this.nativeElement ? this.nativeElement.displayLoadingIndicator = value : undefined;
|
|
240
252
|
}
|
|
241
|
-
/** @description Sets or
|
|
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. */
|
|
242
254
|
get displayMember() {
|
|
243
255
|
return this.nativeElement ? this.nativeElement.displayMember : undefined;
|
|
244
256
|
}
|
|
245
257
|
set displayMember(value) {
|
|
246
258
|
this.nativeElement ? this.nativeElement.displayMember = value : undefined;
|
|
247
259
|
}
|
|
248
|
-
/** @description
|
|
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. */
|
|
249
261
|
get dropDownAppendTo() {
|
|
250
262
|
return this.nativeElement ? this.nativeElement.dropDownAppendTo : undefined;
|
|
251
263
|
}
|
|
252
264
|
set dropDownAppendTo(value) {
|
|
253
265
|
this.nativeElement ? this.nativeElement.dropDownAppendTo = value : undefined;
|
|
254
266
|
}
|
|
255
|
-
/** @description
|
|
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. */
|
|
256
268
|
get dropDownButtonPosition() {
|
|
257
269
|
return this.nativeElement ? this.nativeElement.dropDownButtonPosition : undefined;
|
|
258
270
|
}
|
|
259
271
|
set dropDownButtonPosition(value) {
|
|
260
272
|
this.nativeElement ? this.nativeElement.dropDownButtonPosition = value : undefined;
|
|
261
273
|
}
|
|
262
|
-
/** @description
|
|
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. */
|
|
263
275
|
get dropDownHeight() {
|
|
264
276
|
return this.nativeElement ? this.nativeElement.dropDownHeight : undefined;
|
|
265
277
|
}
|
|
266
278
|
set dropDownHeight(value) {
|
|
267
279
|
this.nativeElement ? this.nativeElement.dropDownHeight = value : undefined;
|
|
268
280
|
}
|
|
269
|
-
/** @description
|
|
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. */
|
|
270
282
|
get dropDownMaxHeight() {
|
|
271
283
|
return this.nativeElement ? this.nativeElement.dropDownMaxHeight : undefined;
|
|
272
284
|
}
|
|
273
285
|
set dropDownMaxHeight(value) {
|
|
274
286
|
this.nativeElement ? this.nativeElement.dropDownMaxHeight = value : undefined;
|
|
275
287
|
}
|
|
276
|
-
/** @description
|
|
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. */
|
|
277
289
|
get dropDownMaxWidth() {
|
|
278
290
|
return this.nativeElement ? this.nativeElement.dropDownMaxWidth : undefined;
|
|
279
291
|
}
|
|
280
292
|
set dropDownMaxWidth(value) {
|
|
281
293
|
this.nativeElement ? this.nativeElement.dropDownMaxWidth = value : undefined;
|
|
282
294
|
}
|
|
283
|
-
/** @description
|
|
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. */
|
|
284
296
|
get dropDownMinHeight() {
|
|
285
297
|
return this.nativeElement ? this.nativeElement.dropDownMinHeight : undefined;
|
|
286
298
|
}
|
|
287
299
|
set dropDownMinHeight(value) {
|
|
288
300
|
this.nativeElement ? this.nativeElement.dropDownMinHeight = value : undefined;
|
|
289
301
|
}
|
|
290
|
-
/** @description
|
|
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. */
|
|
291
303
|
get dropDownMinWidth() {
|
|
292
304
|
return this.nativeElement ? this.nativeElement.dropDownMinWidth : undefined;
|
|
293
305
|
}
|
|
294
306
|
set dropDownMinWidth(value) {
|
|
295
307
|
this.nativeElement ? this.nativeElement.dropDownMinWidth = value : undefined;
|
|
296
308
|
}
|
|
297
|
-
/** @description
|
|
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. */
|
|
298
310
|
get dropDownOpenMode() {
|
|
299
311
|
return this.nativeElement ? this.nativeElement.dropDownOpenMode : undefined;
|
|
300
312
|
}
|
|
301
313
|
set dropDownOpenMode(value) {
|
|
302
314
|
this.nativeElement ? this.nativeElement.dropDownOpenMode = value : undefined;
|
|
303
315
|
}
|
|
304
|
-
/** @description If this property is enabled,
|
|
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. */
|
|
305
317
|
get dropDownOverlay() {
|
|
306
318
|
return this.nativeElement ? this.nativeElement.dropDownOverlay : undefined;
|
|
307
319
|
}
|
|
308
320
|
set dropDownOverlay(value) {
|
|
309
321
|
this.nativeElement ? this.nativeElement.dropDownOverlay = value : undefined;
|
|
310
322
|
}
|
|
311
|
-
/** @description
|
|
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. */
|
|
312
324
|
get dropDownPlaceholder() {
|
|
313
325
|
return this.nativeElement ? this.nativeElement.dropDownPlaceholder : undefined;
|
|
314
326
|
}
|
|
315
327
|
set dropDownPlaceholder(value) {
|
|
316
328
|
this.nativeElement ? this.nativeElement.dropDownPlaceholder = value : undefined;
|
|
317
329
|
}
|
|
318
|
-
/** @description
|
|
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. */
|
|
319
331
|
get dropDownPosition() {
|
|
320
332
|
return this.nativeElement ? this.nativeElement.dropDownPosition : undefined;
|
|
321
333
|
}
|
|
322
334
|
set dropDownPosition(value) {
|
|
323
335
|
this.nativeElement ? this.nativeElement.dropDownPosition = value : undefined;
|
|
324
336
|
}
|
|
325
|
-
/** @description
|
|
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. */
|
|
326
338
|
get dropDownWidth() {
|
|
327
339
|
return this.nativeElement ? this.nativeElement.dropDownWidth : undefined;
|
|
328
340
|
}
|
|
329
341
|
set dropDownWidth(value) {
|
|
330
342
|
this.nativeElement ? this.nativeElement.dropDownWidth = value : undefined;
|
|
331
343
|
}
|
|
332
|
-
/** @description
|
|
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. */
|
|
333
345
|
get escKeyMode() {
|
|
334
346
|
return this.nativeElement ? this.nativeElement.escKeyMode : undefined;
|
|
335
347
|
}
|
|
336
348
|
set escKeyMode(value) {
|
|
337
349
|
this.nativeElement ? this.nativeElement.escKeyMode = value : undefined;
|
|
338
350
|
}
|
|
339
|
-
/** @description
|
|
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. */
|
|
340
352
|
get filterable() {
|
|
341
353
|
return this.nativeElement ? this.nativeElement.filterable : undefined;
|
|
342
354
|
}
|
|
343
355
|
set filterable(value) {
|
|
344
356
|
this.nativeElement ? this.nativeElement.filterable = value : undefined;
|
|
345
357
|
}
|
|
346
|
-
/** @description
|
|
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. */
|
|
347
359
|
get filterInputPlaceholder() {
|
|
348
360
|
return this.nativeElement ? this.nativeElement.filterInputPlaceholder : undefined;
|
|
349
361
|
}
|
|
350
362
|
set filterInputPlaceholder(value) {
|
|
351
363
|
this.nativeElement ? this.nativeElement.filterInputPlaceholder = value : undefined;
|
|
352
364
|
}
|
|
353
|
-
/** @description
|
|
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. */
|
|
354
366
|
get filterMode() {
|
|
355
367
|
return this.nativeElement ? this.nativeElement.filterMode : undefined;
|
|
356
368
|
}
|
|
357
369
|
set filterMode(value) {
|
|
358
370
|
this.nativeElement ? this.nativeElement.filterMode = value : undefined;
|
|
359
371
|
}
|
|
360
|
-
/** @description
|
|
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. */
|
|
361
373
|
get grouped() {
|
|
362
374
|
return this.nativeElement ? this.nativeElement.grouped : undefined;
|
|
363
375
|
}
|
|
364
376
|
set grouped(value) {
|
|
365
377
|
this.nativeElement ? this.nativeElement.grouped = value : undefined;
|
|
366
378
|
}
|
|
367
|
-
/** @description
|
|
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. */
|
|
368
380
|
get groupMember() {
|
|
369
381
|
return this.nativeElement ? this.nativeElement.groupMember : undefined;
|
|
370
382
|
}
|
|
371
383
|
set groupMember(value) {
|
|
372
384
|
this.nativeElement ? this.nativeElement.groupMember = value : undefined;
|
|
373
385
|
}
|
|
374
|
-
/** @description
|
|
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. */
|
|
375
387
|
get hint() {
|
|
376
388
|
return this.nativeElement ? this.nativeElement.hint : undefined;
|
|
377
389
|
}
|
|
378
390
|
set hint(value) {
|
|
379
391
|
this.nativeElement ? this.nativeElement.hint = value : undefined;
|
|
380
392
|
}
|
|
381
|
-
/** @description
|
|
393
|
+
/** @description Controls whether the horizontal scroll bar is displayed within the dropdown menu when the content exceeds the available width. */
|
|
382
394
|
get horizontalScrollBarVisibility() {
|
|
383
395
|
return this.nativeElement ? this.nativeElement.horizontalScrollBarVisibility : undefined;
|
|
384
396
|
}
|
|
385
397
|
set horizontalScrollBarVisibility(value) {
|
|
386
398
|
this.nativeElement ? this.nativeElement.horizontalScrollBarVisibility = value : undefined;
|
|
387
399
|
}
|
|
388
|
-
/** @description Represents the property name of a List item
|
|
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. */
|
|
389
401
|
get inputMember() {
|
|
390
402
|
return this.nativeElement ? this.nativeElement.inputMember : undefined;
|
|
391
403
|
}
|
|
392
404
|
set inputMember(value) {
|
|
393
405
|
this.nativeElement ? this.nativeElement.inputMember = value : undefined;
|
|
394
406
|
}
|
|
395
|
-
/** @description
|
|
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. */
|
|
396
408
|
get inputPurpose() {
|
|
397
409
|
return this.nativeElement ? this.nativeElement.inputPurpose : undefined;
|
|
398
410
|
}
|
|
399
411
|
set inputPurpose(value) {
|
|
400
412
|
this.nativeElement ? this.nativeElement.inputPurpose = value : undefined;
|
|
401
413
|
}
|
|
402
|
-
/** @description IncrementalSearchDelay property
|
|
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. */
|
|
403
415
|
get incrementalSearchDelay() {
|
|
404
416
|
return this.nativeElement ? this.nativeElement.incrementalSearchDelay : undefined;
|
|
405
417
|
}
|
|
406
418
|
set incrementalSearchDelay(value) {
|
|
407
419
|
this.nativeElement ? this.nativeElement.incrementalSearchDelay = value : undefined;
|
|
408
420
|
}
|
|
409
|
-
/** @description
|
|
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. */
|
|
410
422
|
get incrementalSearchMode() {
|
|
411
423
|
return this.nativeElement ? this.nativeElement.incrementalSearchMode : undefined;
|
|
412
424
|
}
|
|
413
425
|
set incrementalSearchMode(value) {
|
|
414
426
|
this.nativeElement ? this.nativeElement.incrementalSearchMode = value : undefined;
|
|
415
427
|
}
|
|
416
|
-
/** @description
|
|
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. */
|
|
417
429
|
get itemHeight() {
|
|
418
430
|
return this.nativeElement ? this.nativeElement.itemHeight : undefined;
|
|
419
431
|
}
|
|
420
432
|
set itemHeight(value) {
|
|
421
433
|
this.nativeElement ? this.nativeElement.itemHeight = value : undefined;
|
|
422
434
|
}
|
|
423
|
-
/** @description
|
|
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. */
|
|
424
436
|
get itemMeasureMode() {
|
|
425
437
|
return this.nativeElement ? this.nativeElement.itemMeasureMode : undefined;
|
|
426
438
|
}
|
|
427
439
|
set itemMeasureMode(value) {
|
|
428
440
|
this.nativeElement ? this.nativeElement.itemMeasureMode = value : undefined;
|
|
429
441
|
}
|
|
430
|
-
/** @description A getter that returns an array
|
|
442
|
+
/** @description A getter method that retrieves and returns an array containing all list ('') elements currently present within the dropdown menu. This allows you to easily access and manipulate every item displayed in the dropdown. */
|
|
431
443
|
get items() {
|
|
432
444
|
return this.nativeElement ? this.nativeElement.items : undefined;
|
|
433
445
|
}
|
|
434
446
|
set items(value) {
|
|
435
447
|
this.nativeElement ? this.nativeElement.items = value : undefined;
|
|
436
448
|
}
|
|
437
|
-
/** @description The itemTemplate property is a string that
|
|
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. */
|
|
438
450
|
get itemTemplate() {
|
|
439
451
|
return this.nativeElement ? this.nativeElement.itemTemplate : undefined;
|
|
440
452
|
}
|
|
441
453
|
set itemTemplate(value) {
|
|
442
454
|
this.nativeElement ? this.nativeElement.itemTemplate = value : undefined;
|
|
443
455
|
}
|
|
444
|
-
/** @description
|
|
456
|
+
/** @description Displays a small text label positioned above the element, typically used to provide context, instructions, or additional information to users. */
|
|
445
457
|
get label() {
|
|
446
458
|
return this.nativeElement ? this.nativeElement.label : undefined;
|
|
447
459
|
}
|
|
448
460
|
set label(value) {
|
|
449
461
|
this.nativeElement ? this.nativeElement.label = value : undefined;
|
|
450
462
|
}
|
|
451
|
-
/** @description
|
|
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. */
|
|
452
464
|
get loadingIndicatorPlaceholder() {
|
|
453
465
|
return this.nativeElement ? this.nativeElement.loadingIndicatorPlaceholder : undefined;
|
|
454
466
|
}
|
|
455
467
|
set loadingIndicatorPlaceholder(value) {
|
|
456
468
|
this.nativeElement ? this.nativeElement.loadingIndicatorPlaceholder = value : undefined;
|
|
457
469
|
}
|
|
458
|
-
/** @description
|
|
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. */
|
|
459
471
|
get loadingIndicatorPosition() {
|
|
460
472
|
return this.nativeElement ? this.nativeElement.loadingIndicatorPosition : undefined;
|
|
461
473
|
}
|
|
462
474
|
set loadingIndicatorPosition(value) {
|
|
463
475
|
this.nativeElement ? this.nativeElement.loadingIndicatorPosition = value : undefined;
|
|
464
476
|
}
|
|
465
|
-
/** @description Sets or
|
|
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
|
+
get unlockKey() {
|
|
479
|
+
return this.nativeElement ? this.nativeElement.unlockKey : undefined;
|
|
480
|
+
}
|
|
481
|
+
set unlockKey(value) {
|
|
482
|
+
this.nativeElement ? this.nativeElement.unlockKey = value : undefined;
|
|
483
|
+
}
|
|
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. */
|
|
466
485
|
get locale() {
|
|
467
486
|
return this.nativeElement ? this.nativeElement.locale : undefined;
|
|
468
487
|
}
|
|
469
488
|
set locale(value) {
|
|
470
489
|
this.nativeElement ? this.nativeElement.locale = value : undefined;
|
|
471
490
|
}
|
|
472
|
-
/** @description
|
|
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. */
|
|
473
492
|
get localizeFormatFunction() {
|
|
474
493
|
return this.nativeElement ? this.nativeElement.localizeFormatFunction : undefined;
|
|
475
494
|
}
|
|
476
495
|
set localizeFormatFunction(value) {
|
|
477
496
|
this.nativeElement ? this.nativeElement.localizeFormatFunction = value : undefined;
|
|
478
497
|
}
|
|
479
|
-
/** @description
|
|
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. */
|
|
480
499
|
get messages() {
|
|
481
500
|
return this.nativeElement ? this.nativeElement.messages : undefined;
|
|
482
501
|
}
|
|
483
502
|
set messages(value) {
|
|
484
503
|
this.nativeElement ? this.nativeElement.messages = value : undefined;
|
|
485
504
|
}
|
|
486
|
-
/** @description
|
|
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. */
|
|
487
506
|
get minLength() {
|
|
488
507
|
return this.nativeElement ? this.nativeElement.minLength : undefined;
|
|
489
508
|
}
|
|
490
509
|
set minLength(value) {
|
|
491
510
|
this.nativeElement ? this.nativeElement.minLength = value : undefined;
|
|
492
511
|
}
|
|
493
|
-
/** @description
|
|
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. */
|
|
494
513
|
get maxLength() {
|
|
495
514
|
return this.nativeElement ? this.nativeElement.maxLength : undefined;
|
|
496
515
|
}
|
|
497
516
|
set maxLength(value) {
|
|
498
517
|
this.nativeElement ? this.nativeElement.maxLength = value : undefined;
|
|
499
518
|
}
|
|
500
|
-
/** @description Sets or
|
|
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. */
|
|
501
520
|
get name() {
|
|
502
521
|
return this.nativeElement ? this.nativeElement.name : undefined;
|
|
503
522
|
}
|
|
504
523
|
set name(value) {
|
|
505
524
|
this.nativeElement ? this.nativeElement.name = value : undefined;
|
|
506
525
|
}
|
|
507
|
-
/** @description
|
|
526
|
+
/** @description Specifies whether the popup is currently visible (open) or hidden (closed) in the user interface. */
|
|
508
527
|
get opened() {
|
|
509
528
|
return this.nativeElement ? this.nativeElement.opened : undefined;
|
|
510
529
|
}
|
|
511
530
|
set opened(value) {
|
|
512
531
|
this.nativeElement ? this.nativeElement.opened = value : undefined;
|
|
513
532
|
}
|
|
514
|
-
/** @description
|
|
533
|
+
/** @description Specifies the placeholder text that appears inside the input field when it is empty, providing guidance or example content to the user. */
|
|
515
534
|
get placeholder() {
|
|
516
535
|
return this.nativeElement ? this.nativeElement.placeholder : undefined;
|
|
517
536
|
}
|
|
518
537
|
set placeholder(value) {
|
|
519
538
|
this.nativeElement ? this.nativeElement.placeholder = value : undefined;
|
|
520
539
|
}
|
|
521
|
-
/** @description
|
|
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. */
|
|
522
541
|
get readonly() {
|
|
523
542
|
return this.nativeElement ? this.nativeElement.readonly : undefined;
|
|
524
543
|
}
|
|
525
544
|
set readonly(value) {
|
|
526
545
|
this.nativeElement ? this.nativeElement.readonly = value : undefined;
|
|
527
546
|
}
|
|
528
|
-
/** @description
|
|
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. */
|
|
529
548
|
get rightToLeft() {
|
|
530
549
|
return this.nativeElement ? this.nativeElement.rightToLeft : undefined;
|
|
531
550
|
}
|
|
532
551
|
set rightToLeft(value) {
|
|
533
552
|
this.nativeElement ? this.nativeElement.rightToLeft = value : undefined;
|
|
534
553
|
}
|
|
535
|
-
/** @description
|
|
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. */
|
|
536
555
|
get resizeIndicator() {
|
|
537
556
|
return this.nativeElement ? this.nativeElement.resizeIndicator : undefined;
|
|
538
557
|
}
|
|
539
558
|
set resizeIndicator(value) {
|
|
540
559
|
this.nativeElement ? this.nativeElement.resizeIndicator = value : undefined;
|
|
541
560
|
}
|
|
542
|
-
/** @description
|
|
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. */
|
|
543
562
|
get resizeMode() {
|
|
544
563
|
return this.nativeElement ? this.nativeElement.resizeMode : undefined;
|
|
545
564
|
}
|
|
546
565
|
set resizeMode(value) {
|
|
547
566
|
this.nativeElement ? this.nativeElement.resizeMode = value : undefined;
|
|
548
567
|
}
|
|
549
|
-
/** @description
|
|
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. */
|
|
550
569
|
get selectionDisplayMode() {
|
|
551
570
|
return this.nativeElement ? this.nativeElement.selectionDisplayMode : undefined;
|
|
552
571
|
}
|
|
553
572
|
set selectionDisplayMode(value) {
|
|
554
573
|
this.nativeElement ? this.nativeElement.selectionDisplayMode = value : undefined;
|
|
555
574
|
}
|
|
556
|
-
/** @description Sets or
|
|
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. */
|
|
557
576
|
get selectedIndexes() {
|
|
558
577
|
return this.nativeElement ? this.nativeElement.selectedIndexes : undefined;
|
|
559
578
|
}
|
|
560
579
|
set selectedIndexes(value) {
|
|
561
580
|
this.nativeElement ? this.nativeElement.selectedIndexes = value : undefined;
|
|
562
581
|
}
|
|
563
|
-
/** @description
|
|
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." */
|
|
564
583
|
get selectedValues() {
|
|
565
584
|
return this.nativeElement ? this.nativeElement.selectedValues : undefined;
|
|
566
585
|
}
|
|
567
586
|
set selectedValues(value) {
|
|
568
587
|
this.nativeElement ? this.nativeElement.selectedValues = value : undefined;
|
|
569
588
|
}
|
|
570
|
-
/** @description
|
|
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. */
|
|
571
590
|
get selectionMode() {
|
|
572
591
|
return this.nativeElement ? this.nativeElement.selectionMode : undefined;
|
|
573
592
|
}
|
|
574
593
|
set selectionMode(value) {
|
|
575
594
|
this.nativeElement ? this.nativeElement.selectionMode = value : undefined;
|
|
576
595
|
}
|
|
577
|
-
/** @description
|
|
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. */
|
|
578
597
|
get sorted() {
|
|
579
598
|
return this.nativeElement ? this.nativeElement.sorted : undefined;
|
|
580
599
|
}
|
|
581
600
|
set sorted(value) {
|
|
582
601
|
this.nativeElement ? this.nativeElement.sorted = value : undefined;
|
|
583
602
|
}
|
|
584
|
-
/** @description
|
|
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. */
|
|
585
604
|
get sortDirection() {
|
|
586
605
|
return this.nativeElement ? this.nativeElement.sortDirection : undefined;
|
|
587
606
|
}
|
|
588
607
|
set sortDirection(value) {
|
|
589
608
|
this.nativeElement ? this.nativeElement.sortDirection = value : undefined;
|
|
590
609
|
}
|
|
591
|
-
/** @description
|
|
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. */
|
|
592
611
|
get theme() {
|
|
593
612
|
return this.nativeElement ? this.nativeElement.theme : undefined;
|
|
594
613
|
}
|
|
595
614
|
set theme(value) {
|
|
596
615
|
this.nativeElement ? this.nativeElement.theme = value : undefined;
|
|
597
616
|
}
|
|
598
|
-
/** @description
|
|
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. */
|
|
599
618
|
get tokenTemplate() {
|
|
600
619
|
return this.nativeElement ? this.nativeElement.tokenTemplate : undefined;
|
|
601
620
|
}
|
|
602
621
|
set tokenTemplate(value) {
|
|
603
622
|
this.nativeElement ? this.nativeElement.tokenTemplate = value : undefined;
|
|
604
623
|
}
|
|
605
|
-
/** @description If
|
|
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. */
|
|
606
625
|
get unfocusable() {
|
|
607
626
|
return this.nativeElement ? this.nativeElement.unfocusable : undefined;
|
|
608
627
|
}
|
|
609
628
|
set unfocusable(value) {
|
|
610
629
|
this.nativeElement ? this.nativeElement.unfocusable = value : undefined;
|
|
611
630
|
}
|
|
612
|
-
/** @description
|
|
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. */
|
|
613
632
|
get value() {
|
|
614
633
|
return this.nativeElement ? this.nativeElement.value : undefined;
|
|
615
634
|
}
|
|
616
635
|
set value(value) {
|
|
617
636
|
this.nativeElement ? this.nativeElement.value = value : undefined;
|
|
618
637
|
}
|
|
619
|
-
/** @description
|
|
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. */
|
|
620
639
|
get valueMember() {
|
|
621
640
|
return this.nativeElement ? this.nativeElement.valueMember : undefined;
|
|
622
641
|
}
|
|
623
642
|
set valueMember(value) {
|
|
624
643
|
this.nativeElement ? this.nativeElement.valueMember = value : undefined;
|
|
625
644
|
}
|
|
626
|
-
/** @description
|
|
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. */
|
|
627
646
|
get verticalScrollBarVisibility() {
|
|
628
647
|
return this.nativeElement ? this.nativeElement.verticalScrollBarVisibility : undefined;
|
|
629
648
|
}
|
|
630
649
|
set verticalScrollBarVisibility(value) {
|
|
631
650
|
this.nativeElement ? this.nativeElement.verticalScrollBarVisibility = value : undefined;
|
|
632
651
|
}
|
|
633
|
-
/** @description Determines
|
|
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. */
|
|
634
653
|
get virtualized() {
|
|
635
654
|
return this.nativeElement ? this.nativeElement.virtualized : undefined;
|
|
636
655
|
}
|
|
637
656
|
set virtualized(value) {
|
|
638
657
|
this.nativeElement ? this.nativeElement.virtualized = value : undefined;
|
|
639
658
|
}
|
|
640
|
-
/** @description Appends a ListItem to the end of the list of items
|
|
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.
|
|
641
660
|
* @param {Node} node. A ListItem element that should be added to the rest of the items as the last item.
|
|
642
661
|
* @returns {Node}
|
|
643
662
|
*/
|
|
@@ -655,7 +674,13 @@ class ComboBoxComponent extends BaseElement {
|
|
|
655
674
|
return result;
|
|
656
675
|
});
|
|
657
676
|
}
|
|
658
|
-
|
|
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.
|
|
659
684
|
* @param {any} item. Describes the properties of the item that will be inserted. You can also pass an array of items.
|
|
660
685
|
*/
|
|
661
686
|
add(item) {
|
|
@@ -668,7 +693,7 @@ class ComboBoxComponent extends BaseElement {
|
|
|
668
693
|
});
|
|
669
694
|
}
|
|
670
695
|
}
|
|
671
|
-
/** @description Removes all items from the
|
|
696
|
+
/** @description Removes all existing items from the dropdown list, resulting in an empty list with no selectable options displayed to the user.
|
|
672
697
|
*/
|
|
673
698
|
clearItems() {
|
|
674
699
|
if (this.nativeElement.isRendered) {
|
|
@@ -680,7 +705,7 @@ class ComboBoxComponent extends BaseElement {
|
|
|
680
705
|
});
|
|
681
706
|
}
|
|
682
707
|
}
|
|
683
|
-
/** @description
|
|
708
|
+
/** @description Deselects all currently selected items, ensuring that no items remain selected. This action clears any existing selections and resets the selection state.
|
|
684
709
|
*/
|
|
685
710
|
clearSelection() {
|
|
686
711
|
if (this.nativeElement.isRendered) {
|
|
@@ -692,7 +717,7 @@ class ComboBoxComponent extends BaseElement {
|
|
|
692
717
|
});
|
|
693
718
|
}
|
|
694
719
|
}
|
|
695
|
-
/** @description Closes the
|
|
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.
|
|
696
721
|
*/
|
|
697
722
|
close() {
|
|
698
723
|
if (this.nativeElement.isRendered) {
|
|
@@ -704,7 +729,7 @@ class ComboBoxComponent extends BaseElement {
|
|
|
704
729
|
});
|
|
705
730
|
}
|
|
706
731
|
}
|
|
707
|
-
/** @description
|
|
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.
|
|
708
733
|
*/
|
|
709
734
|
dataBind() {
|
|
710
735
|
if (this.nativeElement.isRendered) {
|
|
@@ -716,7 +741,7 @@ class ComboBoxComponent extends BaseElement {
|
|
|
716
741
|
});
|
|
717
742
|
}
|
|
718
743
|
}
|
|
719
|
-
/** @description
|
|
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.
|
|
720
745
|
* @param {HTMLElement | string} item. A list item or value of the desired item to be visible.
|
|
721
746
|
*/
|
|
722
747
|
ensureVisible(item) {
|
|
@@ -729,7 +754,7 @@ class ComboBoxComponent extends BaseElement {
|
|
|
729
754
|
});
|
|
730
755
|
}
|
|
731
756
|
}
|
|
732
|
-
/** @description Returns
|
|
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.
|
|
733
758
|
* @param {string} value. The value of an item from the drop down list.
|
|
734
759
|
* @returns {HTMLElement}
|
|
735
760
|
*/
|
|
@@ -747,7 +772,13 @@ class ComboBoxComponent extends BaseElement {
|
|
|
747
772
|
return result;
|
|
748
773
|
});
|
|
749
774
|
}
|
|
750
|
-
|
|
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.
|
|
751
782
|
* @param {number} position. The position where the item must be inserted.
|
|
752
783
|
* @param {any} item. Describes the properties of the item that will be inserted. You can also pass an array of items.
|
|
753
784
|
*/
|
|
@@ -761,7 +792,7 @@ class ComboBoxComponent extends BaseElement {
|
|
|
761
792
|
});
|
|
762
793
|
}
|
|
763
794
|
}
|
|
764
|
-
/** @description Inserts a new ListItem before
|
|
795
|
+
/** @description Inserts a new ListItem element directly before a specified existing ListItem within the list, preserving the order of the remaining items.
|
|
765
796
|
* @param {Node} node. A ListItem element that should be added before the referenceItem in the list.
|
|
766
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.
|
|
767
798
|
* @returns {Node}
|
|
@@ -780,7 +811,13 @@ class ComboBoxComponent extends BaseElement {
|
|
|
780
811
|
return result;
|
|
781
812
|
});
|
|
782
813
|
}
|
|
783
|
-
|
|
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.
|
|
784
821
|
*/
|
|
785
822
|
open() {
|
|
786
823
|
if (this.nativeElement.isRendered) {
|
|
@@ -792,7 +829,7 @@ class ComboBoxComponent extends BaseElement {
|
|
|
792
829
|
});
|
|
793
830
|
}
|
|
794
831
|
}
|
|
795
|
-
/** @description Removes
|
|
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.
|
|
796
833
|
* @param {number} position. The position of the removed item.
|
|
797
834
|
*/
|
|
798
835
|
removeAt(position) {
|
|
@@ -805,7 +842,7 @@ class ComboBoxComponent extends BaseElement {
|
|
|
805
842
|
});
|
|
806
843
|
}
|
|
807
844
|
}
|
|
808
|
-
/** @description Removes a ListItem from the
|
|
845
|
+
/** @description Removes a specified ListItem from the collection of items contained within the given element, updating the list to reflect the deletion.
|
|
809
846
|
* @param {Node} node. A ListItem element that is part of the list of items inside the element.
|
|
810
847
|
* @returns {Node}
|
|
811
848
|
*/
|
|
@@ -823,7 +860,13 @@ class ComboBoxComponent extends BaseElement {
|
|
|
823
860
|
return result;
|
|
824
861
|
});
|
|
825
862
|
}
|
|
826
|
-
|
|
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.
|
|
827
870
|
* @param {string | HTMLElement} item. A string, representing the value of the item or an HTML Element referencing an item from the list
|
|
828
871
|
*/
|
|
829
872
|
select(item) {
|
|
@@ -836,7 +879,7 @@ class ComboBoxComponent extends BaseElement {
|
|
|
836
879
|
});
|
|
837
880
|
}
|
|
838
881
|
}
|
|
839
|
-
/** @description
|
|
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.
|
|
840
883
|
* @param {string | HTMLElement} item. A string, representing the value of the item or an HTML Element referencing an item from the list
|
|
841
884
|
*/
|
|
842
885
|
unselect(item) {
|
|
@@ -849,7 +892,7 @@ class ComboBoxComponent extends BaseElement {
|
|
|
849
892
|
});
|
|
850
893
|
}
|
|
851
894
|
}
|
|
852
|
-
/** @description Updates
|
|
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.
|
|
853
896
|
* @param {number} position. The position where the item must be updated.
|
|
854
897
|
* @param {any} value. The value of the updated item.
|
|
855
898
|
*/
|
|
@@ -871,9 +914,11 @@ class ComboBoxComponent extends BaseElement {
|
|
|
871
914
|
ngAfterViewInit() {
|
|
872
915
|
const that = this;
|
|
873
916
|
that.onCreate.emit(that.nativeElement);
|
|
874
|
-
Smart
|
|
917
|
+
if (Smart)
|
|
918
|
+
Smart.Render();
|
|
875
919
|
this.nativeElement.classList.add('smart-angular');
|
|
876
|
-
this.nativeElement.whenRendered
|
|
920
|
+
if (this.nativeElement.whenRendered)
|
|
921
|
+
this.nativeElement.whenRendered(() => { that.onReady.emit(that.nativeElement); });
|
|
877
922
|
this.listen();
|
|
878
923
|
}
|
|
879
924
|
ngOnDestroy() {
|
|
@@ -1030,7 +1075,7 @@ class ComboBoxComponent extends BaseElement {
|
|
|
1030
1075
|
}
|
|
1031
1076
|
}
|
|
1032
1077
|
ComboBoxComponent.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "13.2.6", ngImport: i0, type: ComboBoxComponent, deps: [{ token: i0.ElementRef }], target: i0.ɵɵFactoryTarget.Directive });
|
|
1033
|
-
ComboBoxComponent.ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "12.0.0", version: "13.2.6", type: ComboBoxComponent, selector: "smart-combo-box, [smart-combo-box]", inputs: { autoCloseDelay: "autoCloseDelay", autoComplete: "autoComplete", autoCompleteDelay: "autoCompleteDelay", autoOpenShortcutKey: "autoOpenShortcutKey", dataSource: "dataSource", disabled: "disabled", displayLoadingIndicator: "displayLoadingIndicator", displayMember: "displayMember", dropDownAppendTo: "dropDownAppendTo", dropDownButtonPosition: "dropDownButtonPosition", dropDownHeight: "dropDownHeight", dropDownMaxHeight: "dropDownMaxHeight", dropDownMaxWidth: "dropDownMaxWidth", dropDownMinHeight: "dropDownMinHeight", dropDownMinWidth: "dropDownMinWidth", dropDownOpenMode: "dropDownOpenMode", dropDownOverlay: "dropDownOverlay", dropDownPlaceholder: "dropDownPlaceholder", dropDownPosition: "dropDownPosition", dropDownWidth: "dropDownWidth", escKeyMode: "escKeyMode", filterable: "filterable", filterInputPlaceholder: "filterInputPlaceholder", filterMode: "filterMode", grouped: "grouped", groupMember: "groupMember", hint: "hint", horizontalScrollBarVisibility: "horizontalScrollBarVisibility", inputMember: "inputMember", inputPurpose: "inputPurpose", incrementalSearchDelay: "incrementalSearchDelay", incrementalSearchMode: "incrementalSearchMode", itemHeight: "itemHeight", itemMeasureMode: "itemMeasureMode", items: "items", itemTemplate: "itemTemplate", label: "label", loadingIndicatorPlaceholder: "loadingIndicatorPlaceholder", loadingIndicatorPosition: "loadingIndicatorPosition", locale: "locale", localizeFormatFunction: "localizeFormatFunction", messages: "messages", minLength: "minLength", maxLength: "maxLength", name: "name", opened: "opened", placeholder: "placeholder", readonly: "readonly", rightToLeft: "rightToLeft", resizeIndicator: "resizeIndicator", resizeMode: "resizeMode", selectionDisplayMode: "selectionDisplayMode", selectedIndexes: "selectedIndexes", selectedValues: "selectedValues", selectionMode: "selectionMode", sorted: "sorted", sortDirection: "sortDirection", theme: "theme", tokenTemplate: "tokenTemplate", unfocusable: "unfocusable", value: "value", valueMember: "valueMember", verticalScrollBarVisibility: "verticalScrollBarVisibility", virtualized: "virtualized" }, outputs: { onChange: "onChange", onClose: "onClose", onClosing: "onClosing", onItemClick: "onItemClick", onOpen: "onOpen", onOpening: "onOpening", onResizeStart: "onResizeStart", onResizeEnd: "onResizeEnd", onScrollBottomReached: "onScrollBottomReached", onScrollTopReached: "onScrollTopReached", onTokenClick: "onTokenClick" }, providers: [CUSTOM_INPUT_CONTROL_VALUE_ACCESSOR], exportAs: ["smart-combo-box"], usesInheritance: true, usesOnChanges: true, ngImport: i0 });
|
|
1078
|
+
ComboBoxComponent.ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "12.0.0", version: "13.2.6", type: ComboBoxComponent, selector: "smart-combo-box, [smart-combo-box]", inputs: { autoCloseDelay: "autoCloseDelay", autoComplete: "autoComplete", autoCompleteDelay: "autoCompleteDelay", autoOpenShortcutKey: "autoOpenShortcutKey", dataSource: "dataSource", disabled: "disabled", displayLoadingIndicator: "displayLoadingIndicator", displayMember: "displayMember", dropDownAppendTo: "dropDownAppendTo", dropDownButtonPosition: "dropDownButtonPosition", dropDownHeight: "dropDownHeight", dropDownMaxHeight: "dropDownMaxHeight", dropDownMaxWidth: "dropDownMaxWidth", dropDownMinHeight: "dropDownMinHeight", dropDownMinWidth: "dropDownMinWidth", dropDownOpenMode: "dropDownOpenMode", dropDownOverlay: "dropDownOverlay", dropDownPlaceholder: "dropDownPlaceholder", dropDownPosition: "dropDownPosition", dropDownWidth: "dropDownWidth", escKeyMode: "escKeyMode", filterable: "filterable", filterInputPlaceholder: "filterInputPlaceholder", filterMode: "filterMode", grouped: "grouped", groupMember: "groupMember", hint: "hint", horizontalScrollBarVisibility: "horizontalScrollBarVisibility", inputMember: "inputMember", inputPurpose: "inputPurpose", incrementalSearchDelay: "incrementalSearchDelay", incrementalSearchMode: "incrementalSearchMode", itemHeight: "itemHeight", itemMeasureMode: "itemMeasureMode", items: "items", itemTemplate: "itemTemplate", label: "label", loadingIndicatorPlaceholder: "loadingIndicatorPlaceholder", loadingIndicatorPosition: "loadingIndicatorPosition", unlockKey: "unlockKey", locale: "locale", localizeFormatFunction: "localizeFormatFunction", messages: "messages", minLength: "minLength", maxLength: "maxLength", name: "name", opened: "opened", placeholder: "placeholder", readonly: "readonly", rightToLeft: "rightToLeft", resizeIndicator: "resizeIndicator", resizeMode: "resizeMode", selectionDisplayMode: "selectionDisplayMode", selectedIndexes: "selectedIndexes", selectedValues: "selectedValues", selectionMode: "selectionMode", sorted: "sorted", sortDirection: "sortDirection", theme: "theme", tokenTemplate: "tokenTemplate", unfocusable: "unfocusable", value: "value", valueMember: "valueMember", verticalScrollBarVisibility: "verticalScrollBarVisibility", virtualized: "virtualized" }, outputs: { onChange: "onChange", onClose: "onClose", onClosing: "onClosing", onItemClick: "onItemClick", onOpen: "onOpen", onOpening: "onOpening", onResizeStart: "onResizeStart", onResizeEnd: "onResizeEnd", onScrollBottomReached: "onScrollBottomReached", onScrollTopReached: "onScrollTopReached", onTokenClick: "onTokenClick" }, providers: [CUSTOM_INPUT_CONTROL_VALUE_ACCESSOR], exportAs: ["smart-combo-box"], usesInheritance: true, usesOnChanges: true, ngImport: i0 });
|
|
1034
1079
|
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.2.6", ngImport: i0, type: ComboBoxComponent, decorators: [{
|
|
1035
1080
|
type: Directive,
|
|
1036
1081
|
args: [{
|
|
@@ -1115,6 +1160,8 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.2.6", ngImpor
|
|
|
1115
1160
|
type: Input
|
|
1116
1161
|
}], loadingIndicatorPosition: [{
|
|
1117
1162
|
type: Input
|
|
1163
|
+
}], unlockKey: [{
|
|
1164
|
+
type: Input
|
|
1118
1165
|
}], locale: [{
|
|
1119
1166
|
type: Input
|
|
1120
1167
|
}], localizeFormatFunction: [{
|
|
@@ -1291,7 +1338,8 @@ class ListItemComponent extends BaseElement {
|
|
|
1291
1338
|
const that = this;
|
|
1292
1339
|
that.onCreate.emit(that.nativeElement);
|
|
1293
1340
|
this.nativeElement.classList.add('smart-angular');
|
|
1294
|
-
this.nativeElement.whenRendered
|
|
1341
|
+
if (this.nativeElement.whenRendered)
|
|
1342
|
+
this.nativeElement.whenRendered(() => { that.onReady.emit(that.nativeElement); });
|
|
1295
1343
|
}
|
|
1296
1344
|
ngOnDestroy() { }
|
|
1297
1345
|
ngOnChanges(changes) {
|
|
@@ -1367,7 +1415,8 @@ class ListItemsGroupComponent extends BaseElement {
|
|
|
1367
1415
|
const that = this;
|
|
1368
1416
|
that.onCreate.emit(that.nativeElement);
|
|
1369
1417
|
this.nativeElement.classList.add('smart-angular');
|
|
1370
|
-
this.nativeElement.whenRendered
|
|
1418
|
+
if (this.nativeElement.whenRendered)
|
|
1419
|
+
this.nativeElement.whenRendered(() => { that.onReady.emit(that.nativeElement); });
|
|
1371
1420
|
}
|
|
1372
1421
|
ngOnDestroy() { }
|
|
1373
1422
|
ngOnChanges(changes) {
|