@progress/kendo-vue-dialogs 8.0.3-develop.2 → 8.0.3-develop.4
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/Dialog.d.ts +158 -0
- package/DialogActionsBar.d.ts +76 -0
- package/DialogTitleBar.d.ts +61 -0
- package/StageEnum.d.ts +12 -0
- package/Window.d.ts +218 -0
- package/WindowProps.d.ts +157 -0
- package/WindowResizeHandlers.d.ts +28 -0
- package/WindowTitlebar.d.ts +111 -0
- package/constants.d.ts +9 -0
- package/dist/cdn/js/kendo-vue-dialogs.js +1 -1
- package/events.d.ts +41 -0
- package/index.d.mts +6 -596
- package/index.d.ts +6 -596
- package/messages/main.d.ts +32 -0
- package/package-metadata.d.ts +12 -0
- package/package-metadata.js +1 -1
- package/package-metadata.mjs +2 -2
- package/package.json +13 -7
package/Dialog.d.ts
ADDED
|
@@ -0,0 +1,158 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
*-------------------------------------------------------------------------------------------
|
|
4
|
+
* Copyright © 2026 Progress Software Corporation. All rights reserved.
|
|
5
|
+
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
6
|
+
*-------------------------------------------------------------------------------------------
|
|
7
|
+
*/
|
|
8
|
+
import { DialogCloseEvent } from './events';
|
|
9
|
+
import { PropType } from 'vue';
|
|
10
|
+
/**
|
|
11
|
+
* Represents the props of the [KendoVue Dialog component]({% slug overview_dialog %}).
|
|
12
|
+
*/
|
|
13
|
+
export interface DialogProps {
|
|
14
|
+
/**
|
|
15
|
+
* Defines the string selector to the element to which the Dialog will be appended. Defaults to its parent element.
|
|
16
|
+
*/
|
|
17
|
+
appendTo?: string;
|
|
18
|
+
/**
|
|
19
|
+
* Sets the title of the Dialog ([see example]({% slug title_dialog %})). If `title` is not specified, the Dialog does not render a **Close** button.
|
|
20
|
+
*/
|
|
21
|
+
title?: string | any;
|
|
22
|
+
/**
|
|
23
|
+
* Defines the custom rendering of the title. Accepts a Vue component, a `render` function, or a slot name.
|
|
24
|
+
*/
|
|
25
|
+
titleRender?: string | Function | object | boolean;
|
|
26
|
+
/**
|
|
27
|
+
* Sets a class of the Dialog DOM element.
|
|
28
|
+
*/
|
|
29
|
+
className?: string;
|
|
30
|
+
/**
|
|
31
|
+
* Specifies whether a close button should be rendered at the top corner of the dialog.
|
|
32
|
+
*/
|
|
33
|
+
closeIcon?: boolean;
|
|
34
|
+
/**
|
|
35
|
+
* Specifies the width of the Dialog ([see example]({% slug dimensions_dialog %})).
|
|
36
|
+
*/
|
|
37
|
+
width?: number | string;
|
|
38
|
+
/**
|
|
39
|
+
* Specifies the height of the Dialog ([see example]({% slug dimensions_dialog %})).
|
|
40
|
+
*/
|
|
41
|
+
height?: number | string;
|
|
42
|
+
/**
|
|
43
|
+
* Specifies the minimum width of the Dialog.
|
|
44
|
+
*/
|
|
45
|
+
minWidth?: number | string;
|
|
46
|
+
/**
|
|
47
|
+
* Specifies the theme color of the Dialog. The available options are `primary`, `dark`, and `light`.
|
|
48
|
+
*/
|
|
49
|
+
themeColor?: 'primary' | 'dark' | 'light' | string;
|
|
50
|
+
/**
|
|
51
|
+
* Fires when the **Close** button in the title is clicked or when the `Esc` button is pressed.
|
|
52
|
+
*/
|
|
53
|
+
onClose?: (event: DialogCloseEvent) => void;
|
|
54
|
+
/**
|
|
55
|
+
* Fires when modal overlay of the Window is clicked.
|
|
56
|
+
*/
|
|
57
|
+
onOverlayclick?: (event: any) => void;
|
|
58
|
+
/**
|
|
59
|
+
* Sets the `aria-labelledby` value.
|
|
60
|
+
*/
|
|
61
|
+
id?: string;
|
|
62
|
+
/**
|
|
63
|
+
* Sets the `id` of the wrapper element.
|
|
64
|
+
*/
|
|
65
|
+
wrapperId?: string;
|
|
66
|
+
/**
|
|
67
|
+
* Represents the `dir` HTML attribute.
|
|
68
|
+
*/
|
|
69
|
+
dir?: string;
|
|
70
|
+
/**
|
|
71
|
+
* The styles that are applied to the Dialog.
|
|
72
|
+
*/
|
|
73
|
+
style?: any;
|
|
74
|
+
/**
|
|
75
|
+
* The styles that are applied to the content of the Dialog.
|
|
76
|
+
*/
|
|
77
|
+
contentStyle?: any;
|
|
78
|
+
dialogClass?: string;
|
|
79
|
+
}
|
|
80
|
+
/**
|
|
81
|
+
* @hidden
|
|
82
|
+
*/
|
|
83
|
+
declare const Dialog: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
|
|
84
|
+
appendTo: PropType<string>;
|
|
85
|
+
title: PropType<any>;
|
|
86
|
+
titleRender: PropType<string | boolean | object | Function>;
|
|
87
|
+
id: PropType<string>;
|
|
88
|
+
wrapperId: PropType<string>;
|
|
89
|
+
dir: PropType<string>;
|
|
90
|
+
closeIcon: {
|
|
91
|
+
type: PropType<boolean>;
|
|
92
|
+
default: boolean;
|
|
93
|
+
};
|
|
94
|
+
width: PropType<string | number>;
|
|
95
|
+
height: PropType<string | number>;
|
|
96
|
+
minWidth: PropType<string | number>;
|
|
97
|
+
className: PropType<string>;
|
|
98
|
+
dialogClass: PropType<string>;
|
|
99
|
+
themeColor: {
|
|
100
|
+
type: PropType<string>;
|
|
101
|
+
validator: (value: any) => any;
|
|
102
|
+
};
|
|
103
|
+
onClose: PropType<(event: DialogCloseEvent) => void>;
|
|
104
|
+
}>, {}, {
|
|
105
|
+
showLicenseWatermark: boolean;
|
|
106
|
+
licenseMessage: any;
|
|
107
|
+
}, {
|
|
108
|
+
wrapperClass(): {
|
|
109
|
+
[x: number]: any;
|
|
110
|
+
'k-dialog-wrapper': boolean;
|
|
111
|
+
};
|
|
112
|
+
dialogElementClass(): {
|
|
113
|
+
[x: string]: any;
|
|
114
|
+
[x: number]: any;
|
|
115
|
+
'k-window': boolean;
|
|
116
|
+
'k-dialog': boolean;
|
|
117
|
+
};
|
|
118
|
+
}, {
|
|
119
|
+
handleCloseDialog(event: any): void;
|
|
120
|
+
handleKeyDown(event: any): void;
|
|
121
|
+
transformDimesion(initialValue: string | number | undefined): string;
|
|
122
|
+
getActionBarIndex(children: any): any;
|
|
123
|
+
generateTitleId(): string;
|
|
124
|
+
generateContentId(): string;
|
|
125
|
+
handleClick(e: any): void;
|
|
126
|
+
}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
|
|
127
|
+
close: (event: DialogCloseEvent) => true;
|
|
128
|
+
overlayclick: any;
|
|
129
|
+
}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
|
|
130
|
+
appendTo: PropType<string>;
|
|
131
|
+
title: PropType<any>;
|
|
132
|
+
titleRender: PropType<string | boolean | object | Function>;
|
|
133
|
+
id: PropType<string>;
|
|
134
|
+
wrapperId: PropType<string>;
|
|
135
|
+
dir: PropType<string>;
|
|
136
|
+
closeIcon: {
|
|
137
|
+
type: PropType<boolean>;
|
|
138
|
+
default: boolean;
|
|
139
|
+
};
|
|
140
|
+
width: PropType<string | number>;
|
|
141
|
+
height: PropType<string | number>;
|
|
142
|
+
minWidth: PropType<string | number>;
|
|
143
|
+
className: PropType<string>;
|
|
144
|
+
dialogClass: PropType<string>;
|
|
145
|
+
themeColor: {
|
|
146
|
+
type: PropType<string>;
|
|
147
|
+
validator: (value: any) => any;
|
|
148
|
+
};
|
|
149
|
+
onClose: PropType<(event: DialogCloseEvent) => void>;
|
|
150
|
+
}>> & Readonly<{
|
|
151
|
+
onClose?: (event: DialogCloseEvent) => any;
|
|
152
|
+
onOverlayclick?: (...args: any[] | unknown[]) => any;
|
|
153
|
+
}>, {
|
|
154
|
+
closeIcon: boolean;
|
|
155
|
+
}, {}, {}, {}, string, () => {
|
|
156
|
+
kCurrentZIndex: number;
|
|
157
|
+
}, true, {}, any>;
|
|
158
|
+
export { Dialog };
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
*-------------------------------------------------------------------------------------------
|
|
4
|
+
* Copyright © 2026 Progress Software Corporation. All rights reserved.
|
|
5
|
+
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
6
|
+
*-------------------------------------------------------------------------------------------
|
|
7
|
+
*/
|
|
8
|
+
import { PropType } from 'vue';
|
|
9
|
+
/**
|
|
10
|
+
* @hidden
|
|
11
|
+
*/
|
|
12
|
+
export interface DialogActionsBarProps {
|
|
13
|
+
/**
|
|
14
|
+
* Set the layout of the actions.
|
|
15
|
+
*
|
|
16
|
+
* The supported values are:
|
|
17
|
+
* * (Default) `start`
|
|
18
|
+
* * `center`
|
|
19
|
+
* * `end`
|
|
20
|
+
* * `stretched`
|
|
21
|
+
*/
|
|
22
|
+
layout: string;
|
|
23
|
+
/**
|
|
24
|
+
* Specifies the orientation of the Dialog action buttons.
|
|
25
|
+
*
|
|
26
|
+
* * The possible values are:
|
|
27
|
+
* * (Default) `horizontal`
|
|
28
|
+
* * `vertical`
|
|
29
|
+
*
|
|
30
|
+
*/
|
|
31
|
+
orientation?: 'horizontal' | 'vertical' | string;
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* @hidden
|
|
35
|
+
*/
|
|
36
|
+
export interface DialogActionsBarComputed {
|
|
37
|
+
[key: string]: any;
|
|
38
|
+
wrapperClasses: object;
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* @hidden
|
|
42
|
+
*/
|
|
43
|
+
declare const DialogActionsBar: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
|
|
44
|
+
layout: {
|
|
45
|
+
type: PropType<string>;
|
|
46
|
+
default: string;
|
|
47
|
+
validator: (value: string) => any;
|
|
48
|
+
};
|
|
49
|
+
orientation: {
|
|
50
|
+
type: PropType<string>;
|
|
51
|
+
default: string;
|
|
52
|
+
validator: (value: string) => any;
|
|
53
|
+
};
|
|
54
|
+
}>, {}, {}, {
|
|
55
|
+
wrapperClasses(): {
|
|
56
|
+
[x: string]: any;
|
|
57
|
+
'k-actions': boolean;
|
|
58
|
+
'k-dialog-actions': boolean;
|
|
59
|
+
'k-window-actions': boolean;
|
|
60
|
+
};
|
|
61
|
+
}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
|
|
62
|
+
layout: {
|
|
63
|
+
type: PropType<string>;
|
|
64
|
+
default: string;
|
|
65
|
+
validator: (value: string) => any;
|
|
66
|
+
};
|
|
67
|
+
orientation: {
|
|
68
|
+
type: PropType<string>;
|
|
69
|
+
default: string;
|
|
70
|
+
validator: (value: string) => any;
|
|
71
|
+
};
|
|
72
|
+
}>> & Readonly<{}>, {
|
|
73
|
+
orientation: string;
|
|
74
|
+
layout: string;
|
|
75
|
+
}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
|
|
76
|
+
export { DialogActionsBar };
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
*-------------------------------------------------------------------------------------------
|
|
4
|
+
* Copyright © 2026 Progress Software Corporation. All rights reserved.
|
|
5
|
+
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
6
|
+
*-------------------------------------------------------------------------------------------
|
|
7
|
+
*/
|
|
8
|
+
import { PropType } from 'vue';
|
|
9
|
+
/**
|
|
10
|
+
* @hidden
|
|
11
|
+
*/
|
|
12
|
+
export interface DialogTitleBarProps {
|
|
13
|
+
/**
|
|
14
|
+
* @hidden
|
|
15
|
+
*/
|
|
16
|
+
onClosebuttonclick?: (event: any) => void;
|
|
17
|
+
/**
|
|
18
|
+
* @hidden
|
|
19
|
+
*/
|
|
20
|
+
id?: string;
|
|
21
|
+
/**
|
|
22
|
+
* @hidden
|
|
23
|
+
*/
|
|
24
|
+
closeIcon?: boolean;
|
|
25
|
+
/**
|
|
26
|
+
* Sets the title of the Dialog .
|
|
27
|
+
* If `title` of 'titleRender' is not specified, the Dialog does not render a **Close** button.
|
|
28
|
+
*/
|
|
29
|
+
title?: string | any;
|
|
30
|
+
/**
|
|
31
|
+
* Defines the custom rendering of the title. Accepts a Vue component, a `render` function, or a slot name.
|
|
32
|
+
*/
|
|
33
|
+
titleRender?: ((h: any, defaultRendering: any | null, props: any, listeners: any) => any) | string | any;
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* @hidden
|
|
37
|
+
*/
|
|
38
|
+
declare const DialogTitleBar: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
|
|
39
|
+
id: PropType<string>;
|
|
40
|
+
closeIcon: {
|
|
41
|
+
type: PropType<boolean>;
|
|
42
|
+
default: boolean;
|
|
43
|
+
};
|
|
44
|
+
title: PropType<any>;
|
|
45
|
+
titleRender: (ObjectConstructor | StringConstructor | FunctionConstructor)[];
|
|
46
|
+
onClosebuttonclick: PropType<(event: any) => void>;
|
|
47
|
+
}>, {}, {}, {}, {
|
|
48
|
+
onCloseButtonClick(e: any): void;
|
|
49
|
+
}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
|
|
50
|
+
id: PropType<string>;
|
|
51
|
+
closeIcon: {
|
|
52
|
+
type: PropType<boolean>;
|
|
53
|
+
default: boolean;
|
|
54
|
+
};
|
|
55
|
+
title: PropType<any>;
|
|
56
|
+
titleRender: (ObjectConstructor | StringConstructor | FunctionConstructor)[];
|
|
57
|
+
onClosebuttonclick: PropType<(event: any) => void>;
|
|
58
|
+
}>> & Readonly<{}>, {
|
|
59
|
+
closeIcon: boolean;
|
|
60
|
+
}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
|
|
61
|
+
export { DialogTitleBar };
|
package/StageEnum.d.ts
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
*-------------------------------------------------------------------------------------------
|
|
4
|
+
* Copyright © 2026 Progress Software Corporation. All rights reserved.
|
|
5
|
+
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
6
|
+
*-------------------------------------------------------------------------------------------
|
|
7
|
+
*/
|
|
8
|
+
export declare enum windowStage {
|
|
9
|
+
DEFAULT = "DEFAULT",
|
|
10
|
+
FULLSCREEN = "FULLSCREEN",
|
|
11
|
+
MINIMIZED = "MINIMIZED"
|
|
12
|
+
}
|
package/Window.d.ts
ADDED
|
@@ -0,0 +1,218 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
*-------------------------------------------------------------------------------------------
|
|
4
|
+
* Copyright © 2026 Progress Software Corporation. All rights reserved.
|
|
5
|
+
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
6
|
+
*-------------------------------------------------------------------------------------------
|
|
7
|
+
*/
|
|
8
|
+
import { WindowActionsEvent, WindowMoveEvent } from './events';
|
|
9
|
+
import { windowStage } from './StageEnum';
|
|
10
|
+
import { PropType } from 'vue';
|
|
11
|
+
/**
|
|
12
|
+
* @hidden
|
|
13
|
+
*/
|
|
14
|
+
declare const Window: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
|
|
15
|
+
id: PropType<string>;
|
|
16
|
+
appendTo: PropType<string>;
|
|
17
|
+
width: {
|
|
18
|
+
type: PropType<number>;
|
|
19
|
+
default: any;
|
|
20
|
+
};
|
|
21
|
+
height: {
|
|
22
|
+
type: PropType<number>;
|
|
23
|
+
default: any;
|
|
24
|
+
};
|
|
25
|
+
left: {
|
|
26
|
+
type: PropType<number>;
|
|
27
|
+
default: any;
|
|
28
|
+
};
|
|
29
|
+
windowStyle: PropType<object>;
|
|
30
|
+
windowClass: PropType<string>;
|
|
31
|
+
top: {
|
|
32
|
+
type: PropType<number>;
|
|
33
|
+
default: any;
|
|
34
|
+
};
|
|
35
|
+
initialWidth: PropType<number>;
|
|
36
|
+
initialHeight: PropType<number>;
|
|
37
|
+
initialLeft: PropType<number>;
|
|
38
|
+
initialTop: PropType<number>;
|
|
39
|
+
minWidth: {
|
|
40
|
+
type: PropType<number>;
|
|
41
|
+
default: number;
|
|
42
|
+
};
|
|
43
|
+
minHeight: {
|
|
44
|
+
type: PropType<number>;
|
|
45
|
+
default: number;
|
|
46
|
+
};
|
|
47
|
+
resizable: {
|
|
48
|
+
type: PropType<boolean>;
|
|
49
|
+
default: boolean;
|
|
50
|
+
};
|
|
51
|
+
draggable: {
|
|
52
|
+
type: PropType<boolean>;
|
|
53
|
+
default: boolean;
|
|
54
|
+
};
|
|
55
|
+
modal: {
|
|
56
|
+
type: PropType<boolean>;
|
|
57
|
+
default: boolean;
|
|
58
|
+
};
|
|
59
|
+
doubleClickStageChange: {
|
|
60
|
+
type: PropType<boolean>;
|
|
61
|
+
default: boolean;
|
|
62
|
+
};
|
|
63
|
+
title: PropType<any>;
|
|
64
|
+
titleRender: PropType<string | object | Function>;
|
|
65
|
+
closeButton: PropType<string | boolean | object | Function>;
|
|
66
|
+
minimizeButton: PropType<string | boolean | object | Function>;
|
|
67
|
+
maximizeButton: PropType<string | boolean | object | Function>;
|
|
68
|
+
restoreButton: PropType<string | boolean | object | Function>;
|
|
69
|
+
shouldUpdateOnDrag: PropType<boolean>;
|
|
70
|
+
stage: {
|
|
71
|
+
type: PropType<string>;
|
|
72
|
+
validator: (value: string) => boolean;
|
|
73
|
+
};
|
|
74
|
+
themeColor: {
|
|
75
|
+
type: PropType<string>;
|
|
76
|
+
validator: (value: any) => any;
|
|
77
|
+
};
|
|
78
|
+
dir: PropType<string>;
|
|
79
|
+
}>, {}, {
|
|
80
|
+
currentStage: string;
|
|
81
|
+
isDragging: boolean;
|
|
82
|
+
currentTop: any;
|
|
83
|
+
currentLeft: any;
|
|
84
|
+
currentWidth: any;
|
|
85
|
+
currentHeight: any;
|
|
86
|
+
titleId: any;
|
|
87
|
+
showLicenseWatermark: boolean;
|
|
88
|
+
licenseMessage: any;
|
|
89
|
+
}, {
|
|
90
|
+
wrapperClass(): {
|
|
91
|
+
'k-dialog-wrapper': any;
|
|
92
|
+
};
|
|
93
|
+
windowElementClass(): {
|
|
94
|
+
[x: string]: any;
|
|
95
|
+
[x: number]: any;
|
|
96
|
+
'k-window': boolean;
|
|
97
|
+
'k-window-minimized': boolean;
|
|
98
|
+
};
|
|
99
|
+
computedTop(): number;
|
|
100
|
+
computedLeft(): number;
|
|
101
|
+
computedWidth(): number;
|
|
102
|
+
computedHeight(): number;
|
|
103
|
+
windowStage(): windowStage | string;
|
|
104
|
+
}, {
|
|
105
|
+
onPress(event: any): void;
|
|
106
|
+
onDrag(event: any): void;
|
|
107
|
+
onRelease(event: any): void;
|
|
108
|
+
handleKeyDown(event: any): void;
|
|
109
|
+
getInitialTop(): any;
|
|
110
|
+
getInitialLeft(): any;
|
|
111
|
+
getInitialWidth(): number;
|
|
112
|
+
getInitialHeight(): number;
|
|
113
|
+
handleMinimize(event: any): void;
|
|
114
|
+
handleFullscreen(event: any): void;
|
|
115
|
+
handleRestore(event: any): void;
|
|
116
|
+
handleCloseWindow(event: any): void;
|
|
117
|
+
handleDoubleClick(e: any): void;
|
|
118
|
+
handleResize(event: any, props: {
|
|
119
|
+
end: boolean;
|
|
120
|
+
direction: string;
|
|
121
|
+
}): void;
|
|
122
|
+
dispatchMoveEvent(eventName: string, event: any, drag: boolean, end: boolean | undefined): void;
|
|
123
|
+
handleBrowserWindowResize(): void;
|
|
124
|
+
handleClick(e: any): void;
|
|
125
|
+
getActionBarIndex(children: any): any;
|
|
126
|
+
generateTitleId(): string;
|
|
127
|
+
}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
|
|
128
|
+
resize: (event: WindowMoveEvent) => true;
|
|
129
|
+
move: (event: WindowMoveEvent) => true;
|
|
130
|
+
close: (event: WindowActionsEvent) => true;
|
|
131
|
+
stagechange: (event: WindowActionsEvent) => true;
|
|
132
|
+
overlayclick: any;
|
|
133
|
+
}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
|
|
134
|
+
id: PropType<string>;
|
|
135
|
+
appendTo: PropType<string>;
|
|
136
|
+
width: {
|
|
137
|
+
type: PropType<number>;
|
|
138
|
+
default: any;
|
|
139
|
+
};
|
|
140
|
+
height: {
|
|
141
|
+
type: PropType<number>;
|
|
142
|
+
default: any;
|
|
143
|
+
};
|
|
144
|
+
left: {
|
|
145
|
+
type: PropType<number>;
|
|
146
|
+
default: any;
|
|
147
|
+
};
|
|
148
|
+
windowStyle: PropType<object>;
|
|
149
|
+
windowClass: PropType<string>;
|
|
150
|
+
top: {
|
|
151
|
+
type: PropType<number>;
|
|
152
|
+
default: any;
|
|
153
|
+
};
|
|
154
|
+
initialWidth: PropType<number>;
|
|
155
|
+
initialHeight: PropType<number>;
|
|
156
|
+
initialLeft: PropType<number>;
|
|
157
|
+
initialTop: PropType<number>;
|
|
158
|
+
minWidth: {
|
|
159
|
+
type: PropType<number>;
|
|
160
|
+
default: number;
|
|
161
|
+
};
|
|
162
|
+
minHeight: {
|
|
163
|
+
type: PropType<number>;
|
|
164
|
+
default: number;
|
|
165
|
+
};
|
|
166
|
+
resizable: {
|
|
167
|
+
type: PropType<boolean>;
|
|
168
|
+
default: boolean;
|
|
169
|
+
};
|
|
170
|
+
draggable: {
|
|
171
|
+
type: PropType<boolean>;
|
|
172
|
+
default: boolean;
|
|
173
|
+
};
|
|
174
|
+
modal: {
|
|
175
|
+
type: PropType<boolean>;
|
|
176
|
+
default: boolean;
|
|
177
|
+
};
|
|
178
|
+
doubleClickStageChange: {
|
|
179
|
+
type: PropType<boolean>;
|
|
180
|
+
default: boolean;
|
|
181
|
+
};
|
|
182
|
+
title: PropType<any>;
|
|
183
|
+
titleRender: PropType<string | object | Function>;
|
|
184
|
+
closeButton: PropType<string | boolean | object | Function>;
|
|
185
|
+
minimizeButton: PropType<string | boolean | object | Function>;
|
|
186
|
+
maximizeButton: PropType<string | boolean | object | Function>;
|
|
187
|
+
restoreButton: PropType<string | boolean | object | Function>;
|
|
188
|
+
shouldUpdateOnDrag: PropType<boolean>;
|
|
189
|
+
stage: {
|
|
190
|
+
type: PropType<string>;
|
|
191
|
+
validator: (value: string) => boolean;
|
|
192
|
+
};
|
|
193
|
+
themeColor: {
|
|
194
|
+
type: PropType<string>;
|
|
195
|
+
validator: (value: any) => any;
|
|
196
|
+
};
|
|
197
|
+
dir: PropType<string>;
|
|
198
|
+
}>> & Readonly<{
|
|
199
|
+
onClose?: (event: WindowActionsEvent) => any;
|
|
200
|
+
onResize?: (event: WindowMoveEvent) => any;
|
|
201
|
+
onOverlayclick?: (...args: any[] | unknown[]) => any;
|
|
202
|
+
onMove?: (event: WindowMoveEvent) => any;
|
|
203
|
+
onStagechange?: (event: WindowActionsEvent) => any;
|
|
204
|
+
}>, {
|
|
205
|
+
draggable: boolean;
|
|
206
|
+
height: number;
|
|
207
|
+
width: number;
|
|
208
|
+
left: number;
|
|
209
|
+
top: number;
|
|
210
|
+
minWidth: number;
|
|
211
|
+
minHeight: number;
|
|
212
|
+
resizable: boolean;
|
|
213
|
+
modal: boolean;
|
|
214
|
+
doubleClickStageChange: boolean;
|
|
215
|
+
}, {}, {}, {}, string, () => {
|
|
216
|
+
kCurrentZIndex: number;
|
|
217
|
+
}, true, {}, any>;
|
|
218
|
+
export { Window };
|
package/WindowProps.d.ts
ADDED
|
@@ -0,0 +1,157 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
*-------------------------------------------------------------------------------------------
|
|
4
|
+
* Copyright © 2026 Progress Software Corporation. All rights reserved.
|
|
5
|
+
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
6
|
+
*-------------------------------------------------------------------------------------------
|
|
7
|
+
*/
|
|
8
|
+
import { WindowActionsEvent, WindowMoveEvent } from './events';
|
|
9
|
+
import { windowStage } from './StageEnum';
|
|
10
|
+
/**
|
|
11
|
+
* Represents the props of the [Window component]({% slug overview_window %}).
|
|
12
|
+
*/
|
|
13
|
+
export interface WindowProps {
|
|
14
|
+
/**
|
|
15
|
+
* The id of the window.
|
|
16
|
+
*/
|
|
17
|
+
id?: string;
|
|
18
|
+
/**
|
|
19
|
+
* Defines the string selector to the element to which the Window will be appended. Defaults to its parent element.
|
|
20
|
+
*/
|
|
21
|
+
appendTo?: string;
|
|
22
|
+
/**
|
|
23
|
+
* Acccepts a named slot `string`, functional or class component for the close button. If set to `false` the button is not rendered.
|
|
24
|
+
*
|
|
25
|
+
* @default true
|
|
26
|
+
*/
|
|
27
|
+
closeButton?: string | Function | object | boolean;
|
|
28
|
+
/**
|
|
29
|
+
* Specifies if the Window stage will change on title double click. The this is on by default.
|
|
30
|
+
*/
|
|
31
|
+
doubleClickStageChange?: boolean;
|
|
32
|
+
/**
|
|
33
|
+
* Specifies if the Window will be draggable ([see example]({% slug positioningdragging_window %}#toc-dragging)).
|
|
34
|
+
*/
|
|
35
|
+
draggable?: boolean;
|
|
36
|
+
/**
|
|
37
|
+
* Specifies the height of the Window ([see example]({% slug dimensionsresizing_window %}#toc-dimensions)).
|
|
38
|
+
*/
|
|
39
|
+
height?: number;
|
|
40
|
+
/**
|
|
41
|
+
* Specifies the initial `left` value ([see example]({% slug positioningdragging_window %}#toc-positioning)). The Window will be in an uncontrolled mode.
|
|
42
|
+
*/
|
|
43
|
+
initialLeft?: number;
|
|
44
|
+
/**
|
|
45
|
+
* Specifies the initial `top` value ([see example]({% slug positioningdragging_window %}#toc-positioning)). The component will be in an uncontrolled mode.
|
|
46
|
+
*/
|
|
47
|
+
initialTop?: number;
|
|
48
|
+
/**
|
|
49
|
+
* Specifies the initial width of the Window ([see example]({% slug dimensionsresizing_window %}#toc-dimensions)). The component will be in an uncontrolled mode.
|
|
50
|
+
*/
|
|
51
|
+
initialWidth?: number;
|
|
52
|
+
/**
|
|
53
|
+
* Specifies the initial height of the Window ([see example]({% slug dimensionsresizing_window %}#toc-dimensions)). The component will be in an uncontrolled mode.
|
|
54
|
+
*/
|
|
55
|
+
initialHeight?: number;
|
|
56
|
+
/**
|
|
57
|
+
* Specifies the left coordinates of the Window.
|
|
58
|
+
*/
|
|
59
|
+
left?: number;
|
|
60
|
+
windowStyle?: object;
|
|
61
|
+
windowClass?: string;
|
|
62
|
+
/**
|
|
63
|
+
* Acccepts a named slot `string`, functional or class component for the maximize button. If set to `false` the button is not rendered.
|
|
64
|
+
*
|
|
65
|
+
* @default true
|
|
66
|
+
*/
|
|
67
|
+
maximizeButton?: string | Function | object | boolean;
|
|
68
|
+
/**
|
|
69
|
+
* Specifies the minimum height of the Window ([see example]({% slug dimensionsresizing_window %}#toc-resizing)).
|
|
70
|
+
*/
|
|
71
|
+
minHeight?: number;
|
|
72
|
+
/**
|
|
73
|
+
* Specifies the minimum width of the Window ([see example]({% slug dimensionsresizing_window %}#toc-resizing)).
|
|
74
|
+
*/
|
|
75
|
+
minWidth?: number;
|
|
76
|
+
/**
|
|
77
|
+
* Acccepts a named slot `string`, functional or class component for the minimize button. If set to `false` the button is not rendered.
|
|
78
|
+
*
|
|
79
|
+
* @default true
|
|
80
|
+
*/
|
|
81
|
+
minimizeButton?: string | Function | object | boolean;
|
|
82
|
+
/**
|
|
83
|
+
* Specifies if the Window will be modal by rendering an overlay under the component.
|
|
84
|
+
*/
|
|
85
|
+
modal?: boolean;
|
|
86
|
+
/**
|
|
87
|
+
* Specifies if the Window will be resizable ([see example]({% slug dimensionsresizing_window %}#toc-resizing)).
|
|
88
|
+
*/
|
|
89
|
+
resizable?: boolean;
|
|
90
|
+
/**
|
|
91
|
+
* Specifies the theme color of the Dialog.
|
|
92
|
+
*/
|
|
93
|
+
themeColor?: 'promary' | 'dark' | 'light' | string;
|
|
94
|
+
/**
|
|
95
|
+
* Acccepts a named slot `string`, functional or class component for the restore button. If set to `false` the button is not rendered.
|
|
96
|
+
*
|
|
97
|
+
* @default true
|
|
98
|
+
*/
|
|
99
|
+
restoreButton?: string | Function | object | boolean;
|
|
100
|
+
/**
|
|
101
|
+
* Specifies if the Window content will update during resizing.
|
|
102
|
+
*/
|
|
103
|
+
shouldUpdateOnDrag?: boolean;
|
|
104
|
+
/**
|
|
105
|
+
* Specifies the title of the Window ([see example]({% slug title_window %})).
|
|
106
|
+
*/
|
|
107
|
+
title?: string | any;
|
|
108
|
+
/**
|
|
109
|
+
* Acccepts a named slot `string`, functional or class component for the title render.
|
|
110
|
+
*/
|
|
111
|
+
titleRender?: string | Function | object;
|
|
112
|
+
/**
|
|
113
|
+
* Specifies the top coordinates of the Window.
|
|
114
|
+
*/
|
|
115
|
+
top?: number;
|
|
116
|
+
/**
|
|
117
|
+
* Specifies the width of the Window.
|
|
118
|
+
*/
|
|
119
|
+
width?: number;
|
|
120
|
+
/**
|
|
121
|
+
* Controls the state of the Window ([see example]({% slug windowstage_window %})).
|
|
122
|
+
*
|
|
123
|
+
* The supported values are:
|
|
124
|
+
* * `DEFAULT`
|
|
125
|
+
* * `MINIMIZED`
|
|
126
|
+
* * `FULLSCREEN`
|
|
127
|
+
*/
|
|
128
|
+
stage?: windowStage | string;
|
|
129
|
+
/**
|
|
130
|
+
* Specifies the direction of the Window content.
|
|
131
|
+
*
|
|
132
|
+
* The supported values are:
|
|
133
|
+
* * `"ltr"`
|
|
134
|
+
* * `"rtl"`
|
|
135
|
+
*/
|
|
136
|
+
dir?: string;
|
|
137
|
+
/**
|
|
138
|
+
* Fires when the **Close** button in the title is clicked or when the `Esc` button is pressed.
|
|
139
|
+
*/
|
|
140
|
+
onClose?: (event: WindowActionsEvent) => void;
|
|
141
|
+
/**
|
|
142
|
+
* Fires when the Window is dragged.
|
|
143
|
+
*/
|
|
144
|
+
onMove?: (event: WindowMoveEvent) => void;
|
|
145
|
+
/**
|
|
146
|
+
* Fires when the `DEFAULT`, `FULLSCREEN`, or `MINIMIZED` state of the Window is changed.
|
|
147
|
+
*/
|
|
148
|
+
onStagechange?: (event: WindowActionsEvent) => void;
|
|
149
|
+
/**
|
|
150
|
+
* Fires when the Window resizes.
|
|
151
|
+
*/
|
|
152
|
+
onResize?: (event: WindowMoveEvent) => void;
|
|
153
|
+
/**
|
|
154
|
+
* Fires when modal overlay of the Window is clicked.
|
|
155
|
+
*/
|
|
156
|
+
onOverlayclick?: (event: any) => void;
|
|
157
|
+
}
|