@smart-webcomponents-angular/window 22.0.2 → 24.0.16
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/esm2020/window/smart.window.mjs +136 -106
- package/fesm2015/smart-webcomponents-angular-window.mjs +135 -105
- package/fesm2015/smart-webcomponents-angular-window.mjs.map +1 -1
- package/fesm2020/smart-webcomponents-angular-window.mjs +135 -105
- package/fesm2020/smart-webcomponents-angular-window.mjs.map +1 -1
- package/index.d.ts +5489 -5228
- package/package.json +1 -1
- package/source/modules/smart.window.js +1 -1
- package/source/smart.button.js +1 -1
- 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.multilinetextbox.js +1 -1
- package/source/smart.progressbar.js +1 -1
- package/source/smart.scrollbar.js +1 -1
- package/source/smart.textbox.js +1 -1
- package/source/smart.window.js +2 -2
- package/styles/smart.base.css +1 -1
- package/styles/smart.window.css +2 -2
- package/window/smart.window.d.ts +110 -105
package/window/smart.window.d.ts
CHANGED
|
@@ -14,34 +14,34 @@ export declare class WindowComponent extends BaseElement implements OnInit, Afte
|
|
|
14
14
|
* @param properties An optional object of properties, which will be added to the template binded ones.
|
|
15
15
|
*/
|
|
16
16
|
createComponent(properties?: {}): any;
|
|
17
|
-
/** @description Determines
|
|
17
|
+
/** @description Determines whether the 'Add New' tab within the Tabs element is currently visible to the user. Note: This property is only relevant when used with the TabsWindow component; it does not apply to other components. */
|
|
18
18
|
get addNewTab(): boolean;
|
|
19
19
|
set addNewTab(value: boolean);
|
|
20
|
-
/** @description Sets or
|
|
20
|
+
/** @description Sets or retrieves the current animation mode. When this property is set to 'none', all animations are disabled. If set to any other supported value, animations will be enabled and behave according to the specified mode. */
|
|
21
21
|
get animation(): Animation | string;
|
|
22
22
|
set animation(value: Animation | string);
|
|
23
|
-
/** @description
|
|
23
|
+
/** @description Controls the automatic capitalization behavior for user input as it is entered or edited. This setting specifies whether characters are auto-capitalized (e.g., sentences, words, or all characters) in the input field. Note: This property is only relevant when used with the MultilinePromptWindow component. */
|
|
24
24
|
get autoCapitalize(): WindowAutoCapitalize | string;
|
|
25
25
|
set autoCapitalize(value: WindowAutoCapitalize | string);
|
|
26
|
-
/** @description
|
|
26
|
+
/** @description Specifies whether the element should automatically expand its height to accommodate vertically overflowing input. Note: This setting only applies to MultilinePromptWindow components. */
|
|
27
27
|
get autoExpand(): boolean;
|
|
28
28
|
set autoExpand(value: boolean);
|
|
29
|
-
/** @description
|
|
29
|
+
/** @description Specifies the text displayed on the 'Cancel' button within the Prompt Window. This label informs users which button will dismiss or close the prompt without taking any action. */
|
|
30
30
|
get cancelLabel(): string;
|
|
31
31
|
set cancelLabel(value: string);
|
|
32
|
-
/** @description
|
|
32
|
+
/** @description Specifies the text that appears on the 'Complete' button within the Progress Window, allowing customization of the button label to better suit user interface requirements. */
|
|
33
33
|
get completeLabel(): string;
|
|
34
34
|
set completeLabel(value: string);
|
|
35
|
-
/** @description
|
|
35
|
+
/** @description Specifies the text displayed on the 'Confirm' button within the Prompt Window, allowing customization of the button label to suit your application's context. */
|
|
36
36
|
get confirmLabel(): string;
|
|
37
37
|
set confirmLabel(value: string);
|
|
38
|
-
/** @description
|
|
38
|
+
/** @description Indicates whether the window is currently collapsed. When set to true, only the window's header is displayed while the content area is hidden. If false, both the header and the full content of the window are visible. */
|
|
39
39
|
get collapsed(): boolean;
|
|
40
40
|
set collapsed(value: boolean);
|
|
41
|
-
/** @description When a modal window is opened,
|
|
41
|
+
/** @description When a modal window is opened, this property specifies whether clicking on the overlay (mask) outside the modal will close the window. Set it to true to allow users to dismiss the modal by clicking the mask, or false to require an explicit action (such as clicking a close button) to close the modal. */
|
|
42
42
|
get closeOnMaskClick(): boolean;
|
|
43
43
|
set closeOnMaskClick(value: boolean);
|
|
44
|
-
/** @description
|
|
44
|
+
/** @description Specifies the data source to be loaded into the TabsWindow component. This property is relevant exclusively for the TabsWindow and will not affect other components. */
|
|
45
45
|
get dataSource(): {
|
|
46
46
|
label: string;
|
|
47
47
|
content: string;
|
|
@@ -50,307 +50,312 @@ export declare class WindowComponent extends BaseElement implements OnInit, Afte
|
|
|
50
50
|
label: string;
|
|
51
51
|
content: string;
|
|
52
52
|
}[]);
|
|
53
|
-
/** @description
|
|
53
|
+
/** @description Controls whether the window is active and visible to the user. When enabled, the window is operational and can be interacted with; when disabled, the window is hidden or inactive, and user interactions are ignored. */
|
|
54
54
|
get disabled(): boolean;
|
|
55
55
|
set disabled(value: boolean);
|
|
56
|
-
/** @description
|
|
56
|
+
/** @description Controls whether the window snapping feature is active. When enabled, users can automatically align and resize windows by dragging them to the edges or corners of the screen. Disabling this feature prevents windows from snapping into place during movement. */
|
|
57
57
|
get disableSnap(): boolean;
|
|
58
58
|
set disableSnap(value: boolean);
|
|
59
|
-
/** @description By default the window
|
|
59
|
+
/** @description By default, pressing the 'Escape' key will automatically close the window. To prevent the window from closing when 'Escape' is pressed, set this property to true. */
|
|
60
60
|
get disableEscape(): boolean;
|
|
61
61
|
set disableEscape(value: boolean);
|
|
62
|
-
/** @description By default the window
|
|
62
|
+
/** @description By default, the window handles certain keyboard inputs such as the arrow keys ('ArrowUp', 'ArrowDown', etc.), 'Escape', and similar keys for scrolling or navigation actions. Set this property to true to disable the window’s default keyboard handling, allowing you to manage these key events manually within your application. */
|
|
63
63
|
get disableKeyboard(): boolean;
|
|
64
64
|
set disableKeyboard(value: boolean);
|
|
65
|
-
/** @description
|
|
65
|
+
/** @description Specifies the visual presentation of characters entered within the input field. For example, this setting can control whether characters are shown as plain text or masked (such as for password fields). This option applies specifically to the Prompt Window component. */
|
|
66
66
|
get displayMode(): WindowDisplayMode | string;
|
|
67
67
|
set displayMode(value: WindowDisplayMode | string);
|
|
68
|
-
/** @description Applicable to TabsWindow when docked
|
|
68
|
+
/** @description ''Applicable to TabsWindow components when they are docked within a DockingLayout Custom Element.This property specifies the valid drop locations for the window—and its tab items—inside the DockingLayout. The property accepts an array of positional values, allowing you to define multiple allowable drop zones.Details: Positions prefixed with 'layout-' apply to each individual tab item (child element) of the TabsWindow being dragged. These determine where tab items can be dropped within the overall layout, outside their original container. Other position values (without the 'layout-' prefix) indicate allowed drop positions directly within the hovered target TabsWindow, specifying where the whole window or its tabs can be placed relative to the target window.Notes: This property is used exclusively by jqxDockingLayout custom elements. It controls the possible drop targets—both at the window and tab levels—within the DockingLayout environment.Allowed Values: The array values specify the permitted drop positions. Refer to the documentation for a complete list of supported position strings. */
|
|
69
69
|
get dropPosition(): WindowDropPosition | string;
|
|
70
70
|
set dropPosition(value: WindowDropPosition | string);
|
|
71
|
-
/** @description A callback function
|
|
71
|
+
/** @description A callback function that specifies how to format the label displayed on the Progress Bar. This function allows customization of the label's content or appearance based on the current progress value. Note: This property is only applicable to the ProgressWindow component. */
|
|
72
72
|
get formatFunction(): any;
|
|
73
73
|
set formatFunction(value: any);
|
|
74
|
-
/** @description
|
|
74
|
+
/** @description Specifies the exact placement or alignment of the footer section within the window element, such as positioning it at the bottom, fixed, absolute, or relative to other content. This property controls where the footer appears in relation to the window’s layout. */
|
|
75
75
|
get footerPosition(): WindowFooterPosition | string;
|
|
76
76
|
set footerPosition(value: WindowFooterPosition | string);
|
|
77
|
-
/** @description
|
|
77
|
+
/** @description Specifies the custom template used to render the footer section of the Dialog window. If footerTemplate is set to null (the default), the Dialog will not display a footer section. You can provide a template string or a function to customize the appearance and content of the Dialog’s footer. */
|
|
78
78
|
get footerTemplate(): any;
|
|
79
79
|
set footerTemplate(value: any);
|
|
80
|
-
/** @description
|
|
80
|
+
/** @description Specifies which buttons will be displayed in the header section, allowing you to control the visibility of header actions for users. */
|
|
81
81
|
get headerButtons(): string[];
|
|
82
82
|
set headerButtons(value: string[]);
|
|
83
|
-
/** @description
|
|
83
|
+
/** @description Specifies the custom template to be used for rendering the header section of the dialog window. If headerTemplate is set to null (the default value), the dialog will display its standard header layout. By providing a template, you can fully customize the appearance and content of the dialog's header area. */
|
|
84
84
|
get headerTemplate(): any;
|
|
85
85
|
set headerTemplate(value: any);
|
|
86
|
-
/** @description
|
|
86
|
+
/** @description Specifies the exact placement of the header section within the window element, such as top, bottom, left, or right. This setting controls where the header appears relative to the content of the window. */
|
|
87
87
|
get headerPosition(): TabPosition | string;
|
|
88
88
|
set headerPosition(value: TabPosition | string);
|
|
89
|
-
/** @description
|
|
89
|
+
/** @description Displays supplementary helper text beneath the text box, providing users with additional guidance or context. This hint appears only when the text box is focused (i.e., the user is actively typing or has selected the field). Note: This property is specifically applicable to the Prompt Window component. */
|
|
90
90
|
get hint(): any;
|
|
91
91
|
set hint(value: any);
|
|
92
|
-
/** @description Sets the
|
|
92
|
+
/** @description Sets the Progress bar value to the indeterminate state ('null'), activating its loading animation to indicate ongoing progress without a defined endpoint. Note: This property is only applicable when used within a ProgressWindow component. */
|
|
93
93
|
get indeterminate(): boolean;
|
|
94
94
|
set indeterminate(value: boolean);
|
|
95
|
-
/** @description
|
|
95
|
+
/** @description Specifies the direction in which the Progress Bar fills (e.g., left-to-right, right-to-left, top-to-bottom, or bottom-to-top). Note: This property is only applicable when used within a ProgressWindow component. */
|
|
96
96
|
get inverted(): boolean;
|
|
97
97
|
set inverted(value: boolean);
|
|
98
|
-
/** @description
|
|
98
|
+
/** @description Specifies the text displayed as the window title in the header section, typically shown at the top of the application window or dialog box. */
|
|
99
99
|
get label(): string;
|
|
100
100
|
set label(value: string);
|
|
101
|
-
/** @description When enabled the resizing operation
|
|
101
|
+
/** @description When enabled, the resizing operation updates the element’s size in real time as the user drags its edges, providing immediate visual feedback. By default, this feature is disabled; instead, a highlighter appears around the edges of the window during resizing to indicate the prospective new size, while the element itself resizes only once the operation is complete. */
|
|
102
102
|
get liveResize(): boolean;
|
|
103
103
|
set liveResize(value: boolean);
|
|
104
|
-
/** @description
|
|
104
|
+
/** @description Note: This property is relevant only for TabsWindow elements that are utilized within a DockingLayout custom element.This property is exclusively used by jqxDockingLayout to specify ownership of a TabsWindow. It determines which jqxDockingLayout instance the window is associated with. If a TabsWindow is removed from its parent DockingLayout element, this property continues to reference the original docking layout to which it belonged.The property accepts either: A string representing the id of a jqxDockingLayout present on the page. An instance of a jqxDockingLayout object.This allows for flexible identification of the owning layout, either by ID or by direct reference to the layout instance. */
|
|
105
105
|
get layout(): any;
|
|
106
106
|
set layout(value: any);
|
|
107
|
-
/** @description
|
|
107
|
+
/** @description Gets or sets the unlockKey, a unique code required to activate or unlock access to the product’s full features or licensed functionality. */
|
|
108
108
|
get unlockKey(): string;
|
|
109
109
|
set unlockKey(value: string);
|
|
110
|
-
/** @description
|
|
110
|
+
/** @description Specifies the language to be used for displaying messages. This property can be set or retrieved, and works in conjunction with the messages property to determine which set of localized messages is shown to the user. Changing the language updates the displayed messages accordingly. */
|
|
111
111
|
get locale(): string;
|
|
112
112
|
set locale(value: string);
|
|
113
|
-
/** @description
|
|
113
|
+
/** @description Note: This property is only applicable to a TabsWindow when it is docked within a DockingLayout custom element. When enabled, it controls whether the TabsWindow can be resized by the user. If set to true, users will be able to adjust the size of the TabsWindow within the DockingLayout; if set to false, resizing will be disabled and the TabsWindow will have a fixed size. */
|
|
114
114
|
get locked(): boolean;
|
|
115
115
|
set locked(value: boolean);
|
|
116
|
-
/** @description Callback,
|
|
116
|
+
/** @description Callback function used within the localization module, typically invoked when a localization event occurs (e.g., language change, resource load). This callback handles tasks such as updating UI elements or retrieving localized content based on the current language settings. */
|
|
117
117
|
get localizeFormatFunction(): any;
|
|
118
118
|
set localizeFormatFunction(value: any);
|
|
119
|
-
/** @description
|
|
119
|
+
/** @description Indicates whether the window is currently maximized. When set to true, the window expands to fill the entire available viewport, covering all other interface elements and leaving no visible borders or title bars. If false, the window retains its previous size and position. This property can be used to programmatically check or control the window’s maximized state within the application. */
|
|
120
120
|
get maximized(): boolean;
|
|
121
121
|
set maximized(value: boolean);
|
|
122
|
-
/** @description
|
|
122
|
+
/** @description Defines or retrieves an object containing localized strings used throughout the widget’s user interface. This property allows developers to customize the widget’s displayed text for different languages and regions. It is typically used together with the locale property to ensure that the widget adapts its content based on the selected language or regional settings. */
|
|
123
123
|
get messages(): any;
|
|
124
124
|
set messages(value: any);
|
|
125
|
-
/** @description
|
|
125
|
+
/** @description Specifies whether the window should function as a modal dialog. When set to true, the window captures user focus and prevents interaction with any other elements on the page until it is closed. This ensures that the user must address or dismiss the modal window before returning to the rest of the content. */
|
|
126
126
|
get modal(): boolean;
|
|
127
127
|
set modal(value: boolean);
|
|
128
|
-
/** @description
|
|
128
|
+
/** @description For use with TabsWindow when docked within a DockingLayout custom element: Specifies the maximum size that the TabsWindow component can occupy when it is docked. For the ProgressWindow component: Defines the maximum value for the progress bar, allowing users to set the upper limit of the ProgressBar's range. */
|
|
129
129
|
get max(): string | number | null;
|
|
130
130
|
set max(value: string | number | null);
|
|
131
|
-
/** @description Applicable to TabsWindow when docked inside DockingLayout
|
|
131
|
+
/** @description Applicable to TabsWindow when docked inside a DockingLayout custom element. Specifies the minimum allowed size for the item within the layout, ensuring it does not shrink below this value during resizing operations.Also applies to ProgressWindow, where it lets the user set the minimum value for the ProgressBar, defining the lowest possible progress state that can be represented. */
|
|
132
132
|
get min(): string | number | null;
|
|
133
133
|
set min(value: string | number | null);
|
|
134
|
-
/** @description
|
|
134
|
+
/** @description Indicates whether the window is currently minimized. When set to true, the window is reduced to an icon or compact form and positioned (docked) in the bottom left corner of the viewport. If false, the window remains in its normal, active state. */
|
|
135
135
|
get minimized(): boolean;
|
|
136
136
|
set minimized(value: boolean);
|
|
137
|
-
/** @description
|
|
137
|
+
/** @description Specifies or retrieves the maximum number of characters a user is allowed to enter into the input field. This property applies to both Prompt and MultilinePrompt windows. If set, the input will be limited to the defined character count, preventing users from entering more characters than specified. */
|
|
138
138
|
get maxLength(): number;
|
|
139
139
|
set maxLength(value: number);
|
|
140
|
-
/** @description
|
|
140
|
+
/** @description Defines the minimum number of characters a user must enter before the autocomplete feature is activated. This property can be both set (to specify the desired threshold) and retrieved (to check the current threshold). Note: This setting is only applicable to Prompt and MultilinePrompt windows. */
|
|
141
141
|
get minLength(): number;
|
|
142
142
|
set minLength(value: number);
|
|
143
|
-
/** @description
|
|
143
|
+
/** @description Indicates whether the window is currently visible to the user. Returns true if the window is displayed on the screen and can be interacted with, and false if it is hidden or minimized. */
|
|
144
144
|
get opened(): boolean;
|
|
145
145
|
set opened(value: boolean);
|
|
146
|
-
/** @description
|
|
146
|
+
/** @description Indicates whether the window is pinned. A pinned window cannot be moved (dragged) by the user, but it can still be resized. When set to true, this property disables window dragging while allowing resizing operations. */
|
|
147
147
|
get pinned(): boolean;
|
|
148
148
|
set pinned(value: boolean);
|
|
149
|
-
/** @description
|
|
149
|
+
/** @description Specifies the placeholder text that appears inside the input field before the user enters a value. Note: This option is only applicable to the Prompt Window component. */
|
|
150
150
|
get placeholder(): string;
|
|
151
151
|
set placeholder(value: string);
|
|
152
|
-
/** @description
|
|
152
|
+
/** @description Specifies the text label displayed above or alongside the input field within the PromptWindow component. This label helps users understand what information is expected in the input field. */
|
|
153
153
|
get promptLabel(): string;
|
|
154
154
|
set promptLabel(value: string);
|
|
155
|
-
/** @description If the element
|
|
155
|
+
/** @description If the element has the "readonly" attribute, users cannot modify its value; the field will display data in a non-editable state, though users can still select and copy its contents. This differs from a "disabled" element, as a "readonly" field remains focusable and included in form submissions. */
|
|
156
156
|
get readonly(): boolean;
|
|
157
157
|
set readonly(value: boolean);
|
|
158
|
-
/** @description When
|
|
158
|
+
/** @description When this option is enabled, a resize handle appears in the bottom-right corner of the window. Users can initiate the resizing operation exclusively by dragging this indicator; resizing from any other window edge or corner is disabled. */
|
|
159
159
|
get resizeIndicator(): boolean;
|
|
160
160
|
set resizeIndicator(value: boolean);
|
|
161
|
-
/** @description
|
|
161
|
+
/** @description Specifies how the window can be resized by the user.Available resizing modes: none – Disables all window resizing; the window size is fixed. vertical – Allows the window to be resized only vertically (top and bottom edges). horizontal – Allows the window to be resized only horizontally (left and right edges). both – Enables both horizontal and vertical resizing; the window can be resized in any direction. top – The window can only be resized by dragging the top edge. bottom – The window can only be resized by dragging the bottom edge. left – The window can only be resized by dragging the left edge. right – The window can only be resized by dragging the right edge.Choose the desired mode to control which edges of the window users can drag to resize, or to prevent resizing entirely. */
|
|
162
162
|
get resizeMode(): WindowResizeMode | string;
|
|
163
163
|
set resizeMode(value: WindowResizeMode | string);
|
|
164
|
-
/** @description
|
|
164
|
+
/** @description Gets or sets a value that determines whether the element’s alignment is configured to support right-to-left (RTL) languages and text direction, such as Arabic or Hebrew. Use this property to ensure proper display and alignment for locales that require RTL font and layout support. */
|
|
165
165
|
get rightToLeft(): boolean;
|
|
166
166
|
set rightToLeft(value: boolean);
|
|
167
|
-
/** @description
|
|
167
|
+
/** @description Indicates that the input field is required and must be filled out by the user before the form can be submitted. If left empty, the form submission will be blocked, prompting the user to complete this field. 'Note:' This setting is applicable to the Prompt Window. */
|
|
168
168
|
get required(): boolean;
|
|
169
169
|
set required(value: boolean);
|
|
170
|
-
/** @description
|
|
170
|
+
/** @description Defines the error message displayed when the required attribute is enabled and the user submits the input field without providing a value. This setting only applies to the Prompt Window interface. */
|
|
171
171
|
get requiredMessage(): string;
|
|
172
172
|
set requiredMessage(value: string);
|
|
173
|
-
/** @description
|
|
173
|
+
/** @description Specifies whether the input field's content should be automatically highlighted (selected) when the field gains focus. Note: This setting applies specifically to the Prompt Window component. */
|
|
174
174
|
get selectAllOnFocus(): boolean;
|
|
175
175
|
set selectAllOnFocus(value: boolean);
|
|
176
|
-
/** @description
|
|
176
|
+
/** @description Specifies or retrieves the currently selected tab within the component. This property applies exclusively to the TabsWindow component. */
|
|
177
177
|
get selectedIndex(): number | null;
|
|
178
178
|
set selectedIndex(value: number | null);
|
|
179
|
-
/** @description
|
|
179
|
+
/** @description Specifies how the user is allowed to navigate between different tabs within the interface. This property is relevant only when using the TabsWindow component. */
|
|
180
180
|
get selectionMode(): TabSelectionMode | string;
|
|
181
181
|
set selectionMode(value: TabSelectionMode | string);
|
|
182
|
-
/** @description
|
|
182
|
+
/** @description Specifies the zero-based index position of the last character included in the current text selection. Note: This property is relevant only for use within MultilinePromptWindow components. */
|
|
183
183
|
get selectionEnd(): number;
|
|
184
184
|
set selectionEnd(value: number);
|
|
185
|
-
/** @description
|
|
185
|
+
/** @description Specifies the zero-based index of the first character in the currently selected text within the prompt window. This property is only applicable when using the MultilinePromptWindow component. */
|
|
186
186
|
get selectionStart(): number;
|
|
187
187
|
set selectionStart(value: number);
|
|
188
|
-
/** @description
|
|
188
|
+
/** @description Controls the visibility of the label displayed on the Progress Bar. Note: This setting is only applicable when used within the Progress Window component. */
|
|
189
189
|
get showProgressValue(): boolean;
|
|
190
190
|
set showProgressValue(value: boolean);
|
|
191
|
-
/** @description A getter that
|
|
191
|
+
/** @description A getter that retrieves all sibling LayoutPanel instances—those sharing the same immediate parent—when a LayoutPanel item is docked within a DockingLayout. The returned siblings are also DockingLayout items (specifically, other LayoutPanels). This property is only available for TabsWindow components that are docked inside a DockingLayout. */
|
|
192
192
|
get siblings(): any;
|
|
193
193
|
set siblings(value: any);
|
|
194
|
-
/** @description
|
|
194
|
+
/** @description Relevant when a TabsWindow component is nested within a DockingLayout custom element. This property specifies the size (width or height, depending on layout orientation) allocated to the TabsWindow within the docking layout, allowing developers to control how much space the window occupies relative to other docked components. */
|
|
195
195
|
get size(): string;
|
|
196
196
|
set size(value: string);
|
|
197
|
-
/** @description
|
|
197
|
+
/** @description Indicates whether spelling and grammar checking should be enabled for the element. This property determines if the content entered within the element will be reviewed for spelling and grammatical errors. Note: This option is only relevant for the MultilinePromptWindow component. */
|
|
198
198
|
get spellCheck(): boolean;
|
|
199
199
|
set spellCheck(value: boolean);
|
|
200
|
-
/** @description
|
|
200
|
+
/** @description Determines whether close buttons are shown on each tab within the Tab Strip of the TabsWindow. You can use this property to enable or disable the visibility of close buttons on tabs, allowing users to close individual tabs directly from the Tab Strip. Note: This property is only applicable to the TabsWindow component. */
|
|
201
201
|
get tabCloseButtons(): boolean;
|
|
202
202
|
set tabCloseButtons(value: boolean);
|
|
203
|
-
/** @description
|
|
203
|
+
/** @description Specifies when the close button is visible—either only when a tab is selected or always visible on all tabs. Note: This property applies exclusively to the TabsWindow component. */
|
|
204
204
|
get tabCloseButtonMode(): WindowTabCloseButtonMode | string;
|
|
205
205
|
set tabCloseButtonMode(value: WindowTabCloseButtonMode | string);
|
|
206
|
-
/** @description
|
|
206
|
+
/** @description Specifies how the scroll buttons for tabs are displayed or behave. This option is only relevant when the tabLayout property is set to 'scroll', allowing tabs to be scrolled horizontally. Note: This property applies exclusively to the TabsWindow component. */
|
|
207
207
|
get tabOverflow(): Overflow | string;
|
|
208
208
|
set tabOverflow(value: Overflow | string);
|
|
209
|
-
/** @description
|
|
209
|
+
/** @description Determines the position of the Tab Strip within the TabsWindow. Note: This property applies exclusively to the TabsWindow component. */
|
|
210
210
|
get tabPosition(): TabPosition | string;
|
|
211
211
|
set tabPosition(value: TabPosition | string);
|
|
212
|
-
/** @description
|
|
212
|
+
/** @description Defines or retrieves the position of the scroll buttons located within the tab header of a TabsWindow component. This setting is exclusively applicable to TabsWindow instances and allows you to control where the scroll buttons appear (for example, at the start, end, or both ends of the tab header). */
|
|
213
213
|
get tabScrollButtonsPosition(): LayoutPosition | string;
|
|
214
214
|
set tabScrollButtonsPosition(value: LayoutPosition | string);
|
|
215
|
-
/** @description
|
|
215
|
+
/** @description Defines or retrieves the orientation of the text displayed in the tab labels within the TabsWindow component. This property determines whether the tab text is laid out horizontally or vertically. Note: This property is exclusively applicable to the TabsWindow component and has no effect on other components. */
|
|
216
216
|
get tabTextOrientation(): Orientation | string;
|
|
217
217
|
set tabTextOrientation(value: Orientation | string);
|
|
218
|
-
/** @description
|
|
218
|
+
/** @description Specifies the visual theme to be applied. The theme controls the appearance, including colors, fonts, and styling, of the element to ensure a consistent look and feel across the user interface. */
|
|
219
219
|
get theme(): string;
|
|
220
220
|
set theme(value: string);
|
|
221
|
-
/** @description If is set to true, the element cannot be
|
|
221
|
+
/** @description If this property is set to true, the element will be excluded from keyboard navigation and cannot receive focus either programmatically or via user interaction. This ensures that users will be unable to focus on the element using methods such as the Tab key or calling focus() in JavaScript. */
|
|
222
222
|
get unfocusable(): boolean;
|
|
223
223
|
set unfocusable(value: boolean);
|
|
224
|
-
/** @description
|
|
224
|
+
/** @description Specifies the current value displayed within the TextBox or ProgressBar component inside a Dialog, Prompt, or Progress Window. This value can represent user input (for TextBox) or progress status (for ProgressBar) and is used to dynamically update the UI element's content or state. */
|
|
225
225
|
get value(): string | number;
|
|
226
226
|
set value(value: string | number);
|
|
227
|
-
/** @description
|
|
227
|
+
/** @description Specifies the actual parent element of the target element. The window's sizing and movement are restricted to the boundaries of this parent element, meaning the window can only be resized or repositioned within the visible area of the designated parent. */
|
|
228
228
|
get windowParent(): any;
|
|
229
229
|
set windowParent(value: any);
|
|
230
|
-
/** @description
|
|
230
|
+
/** @description Specifies the text-wrapping behavior for the input field. Note: This property is only relevant when used with the MultilinePromptWindow component. */
|
|
231
231
|
get wrap(): WindowWrap | string;
|
|
232
232
|
set wrap(value: WindowWrap | string);
|
|
233
|
-
/** @description This event is triggered
|
|
233
|
+
/** @description This event is triggered immediately before the window begins its opening process, allowing developers to perform any preparatory actions or modifications prior to the window becoming visible to the user.
|
|
234
234
|
* @param event. The custom event. */
|
|
235
235
|
onOpening: EventEmitter<CustomEvent>;
|
|
236
|
-
/** @description This event is triggered when the window is opened
|
|
236
|
+
/** @description This event is triggered when the window becomes visible to the user—specifically, when it is opened or brought into view.
|
|
237
237
|
* @param event. The custom event. */
|
|
238
238
|
onOpen: EventEmitter<CustomEvent>;
|
|
239
|
-
/** @description This event is triggered
|
|
239
|
+
/** @description This event is triggered immediately before the window begins the closing process, allowing developers to execute custom logic or prompt the user for confirmation before the window is fully closed.
|
|
240
240
|
* @param event. The custom event. */
|
|
241
241
|
onClosing: EventEmitter<CustomEvent>;
|
|
242
|
-
/** @description This event is triggered when the window is closed
|
|
242
|
+
/** @description This event is triggered when the window is closed or becomes hidden, such as when the user closes the browser tab, navigates away, or minimizes the window, causing it to no longer be visible to the user.
|
|
243
243
|
* @param event. The custom event. */
|
|
244
244
|
onClose: EventEmitter<CustomEvent>;
|
|
245
|
-
/** @description This event is triggered
|
|
245
|
+
/** @description This event is triggered whenever the application window is minimized or collapsed by the user. It allows you to execute custom logic in response to the window being hidden from view.
|
|
246
246
|
* @param event. The custom event. */
|
|
247
247
|
onCollapse: EventEmitter<CustomEvent>;
|
|
248
|
-
/** @description This event is triggered when
|
|
248
|
+
/** @description This event is triggered when the user finishes dragging the window, signaling the completion of the drag-and-drop operation. It occurs after the mouse button is released and the window movement has stopped.
|
|
249
249
|
* @param event. The custom event. */
|
|
250
250
|
onDragEnd: EventEmitter<CustomEvent>;
|
|
251
|
-
/** @description This event is triggered when window
|
|
251
|
+
/** @description This event is triggered when the user initiates a window drag operation, indicating that the dragging of the window has begun. It fires as soon as the user starts moving the window, typically by clicking and holding the window's title bar.
|
|
252
252
|
* @param event. The custom event. */
|
|
253
253
|
onDragStart: EventEmitter<CustomEvent>;
|
|
254
|
-
/** @description This event is triggered
|
|
254
|
+
/** @description This event is triggered whenever the window is resized to a larger size, indicating that the user has expanded the window either by dragging its edges or by maximizing it.
|
|
255
255
|
* @param event. The custom event. */
|
|
256
256
|
onExpand: EventEmitter<CustomEvent>;
|
|
257
|
-
/** @description This event is triggered
|
|
257
|
+
/** @description This event is triggered whenever the application window transitions into a maximized state. It fires immediately after the window expands to fill the available screen space, allowing developers to implement custom logic in response to the window being maximized by the user or programmatically.
|
|
258
258
|
* @param event. The custom event. */
|
|
259
259
|
onMaximize: EventEmitter<CustomEvent>;
|
|
260
|
-
/** @description This event is triggered
|
|
260
|
+
/** @description This event is triggered whenever the application window is minimized by the user. It occurs immediately after the minimize action takes place, allowing developers to execute custom logic—such as pausing background processes, saving state, or updating the UI—in response to the window being minimized.
|
|
261
261
|
* @param event. The custom event. */
|
|
262
262
|
onMinimize: EventEmitter<CustomEvent>;
|
|
263
|
-
/** @description This event is triggered when window
|
|
263
|
+
/** @description This event is triggered when the user completes resizing the browser window, specifically after the resizing action has finished and the window size is no longer changing.
|
|
264
264
|
* @param event. The custom event. */
|
|
265
265
|
onResizeEnd: EventEmitter<CustomEvent>;
|
|
266
|
-
/** @description This event is triggered when window
|
|
266
|
+
/** @description This event is triggered when the user initiates a window resize action, such as clicking and dragging the window’s edge or corner to change its dimensions. It marks the beginning of the window resizing process, allowing you to execute scripts or handle UI updates as soon as resizing starts.
|
|
267
267
|
* @param event. The custom event. */
|
|
268
268
|
onResizeStart: EventEmitter<CustomEvent>;
|
|
269
|
-
/** @description This event is triggered when the window is
|
|
269
|
+
/** @description This event is triggered when the window is returned to its original size and position after being maximized, effectively restoring it to the state it was in prior to maximization.
|
|
270
270
|
* @param event. The custom event. */
|
|
271
271
|
onRestore: EventEmitter<CustomEvent>;
|
|
272
|
-
/** @description Appends a
|
|
272
|
+
/** @description Appends a new tab item to the end of the existing list of tab items within the specified parent element. This operation updates the parent element's tab item collection, ensuring the new tab appears as the last item in the tab navigation.
|
|
273
273
|
* @param {Node} node. A TabItem element that should be added to the rest of the items as the last item.
|
|
274
274
|
* @returns {Node}
|
|
275
275
|
*/
|
|
276
276
|
appendChild(node: any): Promise<any>;
|
|
277
|
-
|
|
277
|
+
appendChildSync(node: any): Node;
|
|
278
|
+
/** @description Sets the window to the highest z-order level, bringing it to the foreground and ensuring it is visible and accessible for user interaction above all other open windows.
|
|
278
279
|
*/
|
|
279
280
|
bringToFront(): void;
|
|
280
|
-
/** @description
|
|
281
|
+
/** @description Removes all existing content from the window, effectively resetting the window’s display area to an empty state. This operation clears any text, images, or elements currently visible within the window.
|
|
281
282
|
*/
|
|
282
283
|
clear(): void;
|
|
283
|
-
/** @description Closes the window.
|
|
284
|
+
/** @description Closes the currently active window in the application, terminating its user interface and releasing any associated resources. If there are unsaved changes or prompts, the user may be asked to confirm before the window is closed.
|
|
284
285
|
*/
|
|
285
286
|
close(): void;
|
|
286
|
-
/** @description
|
|
287
|
+
/** @description Minimizes the window, reducing it to a smaller icon or hidden state, without closing the application.
|
|
287
288
|
* @returns {HTMLElement}
|
|
288
289
|
*/
|
|
289
290
|
collapse(): Promise<any>;
|
|
290
|
-
|
|
291
|
+
collapseSync(): HTMLElement;
|
|
292
|
+
/** @description Ensures the specified tab item is brought into view by automatically scrolling the tab bar as needed. This functionality is exclusive to the TabsWindow component.
|
|
291
293
|
* @param {number} index. The index of the tab to scroll to.
|
|
292
294
|
*/
|
|
293
295
|
ensureVisible(index: number): void;
|
|
294
|
-
/** @description
|
|
296
|
+
/** @description Restores the window to its full size and visibility after it has been collapsed or minimized, allowing users to view and interact with its contents again.
|
|
295
297
|
* @returns {any[]}
|
|
296
298
|
*/
|
|
297
299
|
expand(): Promise<any>;
|
|
298
|
-
|
|
300
|
+
expandSync(): any[];
|
|
301
|
+
/** @description Inserts a new tab along with its corresponding content section into the user interface. This function is specifically designed for use within the TabsWindow component and will not operate outside of this context.
|
|
299
302
|
* @param {number} index. The index to insert a new tab at.
|
|
300
303
|
* @param {any} details. An Object with the fields "label", "labelSize", "content" and "group".
|
|
301
304
|
*/
|
|
302
305
|
insert(index: number, details: any): void;
|
|
303
|
-
/** @description Inserts the specified "smart-tab-item" node before the reference "smart-tab-item" node.
|
|
306
|
+
/** @description Inserts the specified "smart-tab-item" node directly before the reference "smart-tab-item" node within the tab collection. This operation is only applicable when manipulating tab items inside a TabsWindow component.
|
|
304
307
|
* @param {Node} newNode. The "smart-tab-item" node to insert.
|
|
305
308
|
* @param {Node | null} referenceNode?. The "smart-tab-item" node before which newNode is inserted.
|
|
306
309
|
* @returns {Node}
|
|
307
310
|
*/
|
|
308
311
|
insertBefore(newNode: any, referenceNode?: any): Promise<any>;
|
|
309
|
-
|
|
312
|
+
insertBeforeSync(newNode: any, referenceNode?: any): Node;
|
|
313
|
+
/** @description Revised Description:"Sets the window's position on the screen by moving it to specified X and Y coordinates, effectively relocating the window to a new location."
|
|
310
314
|
* @param {string | number} left. Left position. For example: '100px'.
|
|
311
315
|
* @param {string | number} top. Top position. For example: '100px'.
|
|
312
316
|
*/
|
|
313
317
|
move(left: string | number, top: string | number): void;
|
|
314
|
-
/** @description
|
|
318
|
+
/** @description Expands the window to occupy the entire available viewing area, ensuring it fills all usable screen space without overlapping system taskbars or menus.
|
|
315
319
|
*/
|
|
316
320
|
maximize(): void;
|
|
317
|
-
/** @description
|
|
321
|
+
/** @description Reduces the window to the taskbar or dock, temporarily hiding it from view without closing the application.
|
|
318
322
|
*/
|
|
319
323
|
minimize(): void;
|
|
320
|
-
/** @description Opens the
|
|
324
|
+
/** @description Opens a new browser window or tab with the specified URL or content, allowing additional web pages or resources to be displayed alongside the current page.
|
|
321
325
|
*/
|
|
322
326
|
open(): void;
|
|
323
|
-
/** @description
|
|
327
|
+
/** @description Prevents the window from being moved by locking its position. Disables the ability to drag or reposition the window, ensuring it remains fixed in place.
|
|
324
328
|
*/
|
|
325
329
|
pin(): void;
|
|
326
|
-
/** @description Removes a tab
|
|
330
|
+
/** @description Removes a tab along with its corresponding content section from the interface. This function is designed to work exclusively within the TabsWindow component.
|
|
327
331
|
* @param {number} index. The index of the tab to remove.
|
|
328
332
|
*/
|
|
329
333
|
removeAt(index: number): void;
|
|
330
|
-
/** @description Removes a child "smart-tab-item"
|
|
334
|
+
/** @description Removes a child node with the "smart-tab-item" tag from the parent container. Note: This operation is only supported within the TabsWindow component; attempting to use it elsewhere will have no effect.
|
|
331
335
|
* @param {Node} node. The "smart-tab-item" node to remove.
|
|
332
336
|
* @returns {Node}
|
|
333
337
|
*/
|
|
334
338
|
removeChild(node: any): Promise<any>;
|
|
335
|
-
|
|
339
|
+
removeChildSync(node: any): Node;
|
|
340
|
+
/** @description Restores the window to its previous dimensions and position before it was maximized or minimized, returning it to the exact size and location it had prior to those actions.
|
|
336
341
|
*/
|
|
337
342
|
restore(): void;
|
|
338
|
-
/** @description Selects
|
|
343
|
+
/** @description Selects the specified tab within the interface. This action applies exclusively to elements of type TabsWindow.
|
|
339
344
|
* @param {number} index. The index of the tab to select.
|
|
340
345
|
*/
|
|
341
346
|
select(index: number): void;
|
|
342
|
-
/** @description
|
|
347
|
+
/** @description Removes the pinned (fixed) state from the window, allowing the user to freely move or drag the window to a different position on the screen.
|
|
343
348
|
*/
|
|
344
349
|
unpin(): void;
|
|
345
|
-
/** @description Updates the header label.
|
|
350
|
+
/** @description Updates the text displayed in the header label to reflect new information or changes, ensuring that the header accurately represents the current content or context of the section.
|
|
346
351
|
* @param {string} label. The new label of the Header.
|
|
347
352
|
*/
|
|
348
353
|
updateLabel(label: string): void;
|
|
349
|
-
/** @description
|
|
354
|
+
/** @description Replaces the existing content with new or modified information, ensuring that the displayed data reflects the latest updates or changes.
|
|
350
355
|
* @param {string | HTMLElement} content. The new content of the window.
|
|
351
356
|
*/
|
|
352
357
|
updateContent(content: string | HTMLElement): void;
|
|
353
|
-
/** @description Updates
|
|
358
|
+
/** @description Updates an individual tab within a TabsWindow component and modifies its corresponding content section. This operation exclusively applies to elements of the TabsWindow type. Use this function to change tab labels, update active states, or refresh the content associated with a specific tab within the TabsWindow interface.
|
|
354
359
|
* @param {number} index. The index of the tab to update.
|
|
355
360
|
* @param {string} label. The new label of the tab. The value can be the id of an HTMLTemplateElement
|
|
356
361
|
* @param {string | HTMLElement} content. The new content of the tab.
|