@progress/kendo-react-popup 13.3.0 → 13.4.0-develop.2
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/Popup.d.ts +99 -0
- package/animation.d.ts +12 -0
- package/dist/cdn/js/kendo-react-popup.js +1 -1
- package/index.d.mts +11 -631
- package/index.d.ts +11 -631
- package/models/Align.d.ts +31 -0
- package/models/Collision.d.ts +21 -0
- package/models/CollisionType.d.ts +17 -0
- package/models/Events.d.ts +64 -0
- package/models/Margin.d.ts +21 -0
- package/models/Offset.d.ts +21 -0
- package/models/PopupAnimation.d.ts +188 -0
- package/models/PopupProps.d.ts +235 -0
- package/models/PopupSettings.d.ts +93 -0
- package/models/PositionMode.d.ts +12 -0
- package/package-metadata.d.ts +12 -0
- package/package-metadata.mjs +13 -0
- package/package.json +9 -3
- package/util.d.ts +24 -0
|
@@ -0,0 +1,17 @@
|
|
|
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 { CollisionType as CollisionTypeBase } from '@progress/kendo-popup-common';
|
|
9
|
+
/**
|
|
10
|
+
* Defines the possible collision behavior when the Popup is not fully visible.
|
|
11
|
+
*
|
|
12
|
+
* The available options are:
|
|
13
|
+
* - `fit`—Moves the Popup horizontally until it is fully displayed in the viewport.
|
|
14
|
+
* - `flip`—Flips the Popup position based on the origin and the position properties.
|
|
15
|
+
* - `none`—The Popup is rendered at its original position.
|
|
16
|
+
*/
|
|
17
|
+
export type CollisionType = CollisionTypeBase;
|
|
@@ -0,0 +1,64 @@
|
|
|
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 { PopupHandle, PopupState } from '../Popup.js';
|
|
9
|
+
/**
|
|
10
|
+
* Represents the object of the `Open` Popup event.
|
|
11
|
+
*/
|
|
12
|
+
export interface OpenEvent {
|
|
13
|
+
/**
|
|
14
|
+
* An event target.
|
|
15
|
+
*/
|
|
16
|
+
target: PopupHandle;
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* Represents the object of the `Close` Popup event.
|
|
20
|
+
*/
|
|
21
|
+
export interface CloseEvent {
|
|
22
|
+
/**
|
|
23
|
+
* An event target.
|
|
24
|
+
*/
|
|
25
|
+
target: PopupHandle;
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Represents the object of the `Position` Popup event.
|
|
29
|
+
*/
|
|
30
|
+
export interface PositionEvent {
|
|
31
|
+
/**
|
|
32
|
+
* An event target.
|
|
33
|
+
*/
|
|
34
|
+
target: PopupHandle;
|
|
35
|
+
/**
|
|
36
|
+
* Indicates if the position is fitted.
|
|
37
|
+
*/
|
|
38
|
+
fitted: boolean;
|
|
39
|
+
/**
|
|
40
|
+
* Indicates if the position is flipped.
|
|
41
|
+
*/
|
|
42
|
+
flipped: boolean;
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Represents the object of the `MouseDownOutside` Popup event.
|
|
46
|
+
*/
|
|
47
|
+
export interface MouseDownOutsideEvent {
|
|
48
|
+
/**
|
|
49
|
+
* An event target.
|
|
50
|
+
*/
|
|
51
|
+
target: PopupHandle;
|
|
52
|
+
/**
|
|
53
|
+
* The event object.
|
|
54
|
+
*/
|
|
55
|
+
event: MouseEvent;
|
|
56
|
+
/**
|
|
57
|
+
* The state of the Popup.
|
|
58
|
+
*/
|
|
59
|
+
state: PopupState;
|
|
60
|
+
/**
|
|
61
|
+
* Indicates if the MouseDown event is triggered over the anchor of the Popup.
|
|
62
|
+
*/
|
|
63
|
+
isAnchorClicked: boolean;
|
|
64
|
+
}
|
|
@@ -0,0 +1,21 @@
|
|
|
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 { MarginSettings } from '@progress/kendo-popup-common';
|
|
9
|
+
/**
|
|
10
|
+
* Defines the horizontal and the vertical margin offset of the component.
|
|
11
|
+
*/
|
|
12
|
+
export interface Margin extends MarginSettings {
|
|
13
|
+
/**
|
|
14
|
+
* Defines the possible horizontal margin value.
|
|
15
|
+
*/
|
|
16
|
+
horizontal: number;
|
|
17
|
+
/**
|
|
18
|
+
* Defines the possible vertical margin value.
|
|
19
|
+
*/
|
|
20
|
+
vertical: number;
|
|
21
|
+
}
|
|
@@ -0,0 +1,21 @@
|
|
|
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 { OffsetPosition } from '@progress/kendo-popup-common';
|
|
9
|
+
/**
|
|
10
|
+
* The offset position of the Popup.
|
|
11
|
+
*/
|
|
12
|
+
export interface Offset extends OffsetPosition {
|
|
13
|
+
/**
|
|
14
|
+
* Defines the top position of the Popup.
|
|
15
|
+
*/
|
|
16
|
+
top: number;
|
|
17
|
+
/**
|
|
18
|
+
* Defines the left position of the Popup.
|
|
19
|
+
*/
|
|
20
|
+
left: number;
|
|
21
|
+
}
|
|
@@ -0,0 +1,188 @@
|
|
|
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
|
+
/**
|
|
9
|
+
* The possible base directions for slide and push animations.
|
|
10
|
+
*
|
|
11
|
+
* Possible values: 'left', 'right', 'up', 'down'.
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* <Popup animation={{ direction: 'left' }} />
|
|
15
|
+
*/
|
|
16
|
+
export type PopupBaseDirections = 'left' | 'right' | 'up' | 'down';
|
|
17
|
+
/**
|
|
18
|
+
* The possible directions for zoom animations.
|
|
19
|
+
*
|
|
20
|
+
* Possible values: 'in', 'out'.
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* <Popup animation={{ type: 'zoom', direction: 'in' }} />
|
|
24
|
+
*/
|
|
25
|
+
export type PopupZoomDirections = 'in' | 'out';
|
|
26
|
+
/**
|
|
27
|
+
* The possible directions for expand animations.
|
|
28
|
+
*
|
|
29
|
+
* Possible values: 'horizontal', 'vertical'.
|
|
30
|
+
*
|
|
31
|
+
* @example
|
|
32
|
+
* <Popup animation={{ type: 'expand', direction: 'vertical' }} />
|
|
33
|
+
*/
|
|
34
|
+
export type PopupExpandDirection = 'horizontal' | 'vertical';
|
|
35
|
+
/**
|
|
36
|
+
* Represents no direction for fade animation.
|
|
37
|
+
*
|
|
38
|
+
* Possible value: 'none'.
|
|
39
|
+
*
|
|
40
|
+
* @example
|
|
41
|
+
* <Popup animation={{ type: 'fade', direction: 'none' }} />
|
|
42
|
+
*/
|
|
43
|
+
export type PopupNoDirection = 'none';
|
|
44
|
+
/**
|
|
45
|
+
* The available animation types for the Popup component.
|
|
46
|
+
*
|
|
47
|
+
* Possible values: 'slide', 'zoom', 'push', 'expand', 'fade'.
|
|
48
|
+
*
|
|
49
|
+
* @example
|
|
50
|
+
* <Popup animation={{ type: 'slide' }} />
|
|
51
|
+
*/
|
|
52
|
+
export declare const animationTypes: {
|
|
53
|
+
readonly slide: "slide";
|
|
54
|
+
readonly zoom: "zoom";
|
|
55
|
+
readonly push: "push";
|
|
56
|
+
readonly expand: "expand";
|
|
57
|
+
readonly fade: "fade";
|
|
58
|
+
};
|
|
59
|
+
/**
|
|
60
|
+
* The type representing all possible animation type values.
|
|
61
|
+
*
|
|
62
|
+
* Possible values: 'slide', 'zoom', 'push', 'expand', 'fade'
|
|
63
|
+
*
|
|
64
|
+
* @example
|
|
65
|
+
* <Popup animation={{ type: 'fade' }} />
|
|
66
|
+
*/
|
|
67
|
+
export type PopupAnimationType = (typeof animationTypes)[keyof typeof animationTypes];
|
|
68
|
+
/**
|
|
69
|
+
* Defines the base animation settings for the Popup component.
|
|
70
|
+
*
|
|
71
|
+
* Includes duration properties for opening and closing animations
|
|
72
|
+
*
|
|
73
|
+
* @example
|
|
74
|
+
* <Popup animation={{ openDuration: 500, closeDuration: 200 }} />
|
|
75
|
+
*/
|
|
76
|
+
export interface PopupAnimationBase {
|
|
77
|
+
/**
|
|
78
|
+
* The duration of the opening animation in milliseconds. Defaults to `300ms`.
|
|
79
|
+
*/
|
|
80
|
+
openDuration?: number;
|
|
81
|
+
/**
|
|
82
|
+
* The duration of the closing animation in milliseconds. Defaults to `300ms`.
|
|
83
|
+
*/
|
|
84
|
+
closeDuration?: number;
|
|
85
|
+
}
|
|
86
|
+
/**
|
|
87
|
+
* Defines the slide animation settings for the Popup component.
|
|
88
|
+
*
|
|
89
|
+
* Use this to configure slide type and direction
|
|
90
|
+
*
|
|
91
|
+
* @example
|
|
92
|
+
* <Popup animation={{ type: 'slide', direction: 'left' }} />
|
|
93
|
+
*/
|
|
94
|
+
export interface SlidePopupAnimation {
|
|
95
|
+
/**
|
|
96
|
+
* The type of the animation. Default is 'slide'.
|
|
97
|
+
*/
|
|
98
|
+
type?: typeof animationTypes.slide;
|
|
99
|
+
/**
|
|
100
|
+
* The direction of the slide animation. Possible values: 'left', 'right', 'up', 'down'.
|
|
101
|
+
*/
|
|
102
|
+
direction?: PopupBaseDirections;
|
|
103
|
+
}
|
|
104
|
+
/**
|
|
105
|
+
* Defines the zoom animation settings for the Popup component.
|
|
106
|
+
*
|
|
107
|
+
* Use this to configure zoom type and direction
|
|
108
|
+
*
|
|
109
|
+
* @example
|
|
110
|
+
* <Popup animation={{ type: 'zoom', direction: 'in' }} />
|
|
111
|
+
*/
|
|
112
|
+
export interface ZoomPopupAnimation {
|
|
113
|
+
/**
|
|
114
|
+
* The type of the animation. Must be 'zoom'.
|
|
115
|
+
*/
|
|
116
|
+
type: typeof animationTypes.zoom;
|
|
117
|
+
/**
|
|
118
|
+
* The direction of the zoom animation. Possible values: 'in', 'out'.
|
|
119
|
+
*/
|
|
120
|
+
direction: PopupZoomDirections;
|
|
121
|
+
}
|
|
122
|
+
/**
|
|
123
|
+
* Defines the fade animation settings for the Popup component.
|
|
124
|
+
*
|
|
125
|
+
* Use this to configure fade type. Direction is always 'none'.
|
|
126
|
+
*
|
|
127
|
+
* @example
|
|
128
|
+
* <Popup animation={{ type: 'fade' }} />
|
|
129
|
+
*/
|
|
130
|
+
export interface FadePopupAnimation {
|
|
131
|
+
/**
|
|
132
|
+
* The type of the animation. Must be 'fade'.
|
|
133
|
+
*/
|
|
134
|
+
type: typeof animationTypes.fade;
|
|
135
|
+
/**
|
|
136
|
+
* @hidden
|
|
137
|
+
*/
|
|
138
|
+
direction?: PopupNoDirection;
|
|
139
|
+
}
|
|
140
|
+
/**
|
|
141
|
+
* Defines the push animation settings for the Popup component.
|
|
142
|
+
*
|
|
143
|
+
* Use this to configure push type and direction
|
|
144
|
+
*
|
|
145
|
+
* @example
|
|
146
|
+
* <Popup animation={{ type: 'push', direction: 'down' }} />
|
|
147
|
+
*/
|
|
148
|
+
export interface PushPopupAnimation {
|
|
149
|
+
/**
|
|
150
|
+
* The type of the animation. Must be 'push'.
|
|
151
|
+
*/
|
|
152
|
+
type: typeof animationTypes.push;
|
|
153
|
+
/**
|
|
154
|
+
* The direction of the push animation. Possible values: 'left', 'right', 'up', 'down'.
|
|
155
|
+
*/
|
|
156
|
+
direction: PopupBaseDirections;
|
|
157
|
+
}
|
|
158
|
+
/**
|
|
159
|
+
* Defines the expand animation settings for the Popup component.
|
|
160
|
+
*
|
|
161
|
+
* Use this to configure expand type and direction
|
|
162
|
+
*
|
|
163
|
+
* @example
|
|
164
|
+
* <Popup animation={{ type: 'expand', direction: 'vertical' }} />
|
|
165
|
+
*/
|
|
166
|
+
export interface ExpandPopupAnimation {
|
|
167
|
+
/**
|
|
168
|
+
* The type of the animation. Must be 'expand'.
|
|
169
|
+
*/
|
|
170
|
+
type: typeof animationTypes.expand;
|
|
171
|
+
/**
|
|
172
|
+
* The direction of the expand animation. Possible values: 'horizontal', 'vertical'.
|
|
173
|
+
*/
|
|
174
|
+
direction: PopupExpandDirection;
|
|
175
|
+
}
|
|
176
|
+
/**
|
|
177
|
+
* The animation settings for the Popup component
|
|
178
|
+
*/
|
|
179
|
+
export type PopupAnimation = PopupAnimationBase & (FadePopupAnimation | SlidePopupAnimation | ZoomPopupAnimation | PushPopupAnimation | ExpandPopupAnimation);
|
|
180
|
+
/**
|
|
181
|
+
* Represents all possible direction values for Popup animations.
|
|
182
|
+
*
|
|
183
|
+
* Includes directions for slide, zoom, push, expand, and fade animations.
|
|
184
|
+
* Useful for type-safe direction assignment in animation settings.
|
|
185
|
+
*
|
|
186
|
+
* Possible values: 'left', 'right', 'up', 'down', 'in', 'out', 'horizontal', 'vertical', 'none'.
|
|
187
|
+
*/
|
|
188
|
+
export type PopupAnimationDirection = NonNullable<FadePopupAnimation['direction'] | SlidePopupAnimation['direction'] | ZoomPopupAnimation['direction'] | PushPopupAnimation['direction'] | ExpandPopupAnimation['direction']>;
|
|
@@ -0,0 +1,235 @@
|
|
|
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 { Collision } from './Collision.js';
|
|
9
|
+
import { Align } from './Align.js';
|
|
10
|
+
import { OpenEvent, CloseEvent, PositionEvent, MouseDownOutsideEvent } from './Events.js';
|
|
11
|
+
import { Offset } from './Offset.js';
|
|
12
|
+
import { PopupAnimation } from './PopupAnimation.js';
|
|
13
|
+
import { Margin } from './Margin.js';
|
|
14
|
+
import { PositionMode } from './PositionMode.js';
|
|
15
|
+
import { PopupSettings } from '@progress/kendo-popup-common';
|
|
16
|
+
import { PopupClassStructure } from '@progress/kendo-react-common';
|
|
17
|
+
/**
|
|
18
|
+
* Represents the props of the [KendoReact Popup component](https://www.telerik.com/kendo-react-ui/components/popup).
|
|
19
|
+
*/
|
|
20
|
+
export interface PopupProps extends PopupSettings {
|
|
21
|
+
/**
|
|
22
|
+
* Controls the Popup animation ([see example](https://www.telerik.com/kendo-react-ui/components/popup/animations)). By default, the opening and closing animations are enabled.
|
|
23
|
+
*
|
|
24
|
+
* @default true
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* ```jsx
|
|
28
|
+
* <Popup animate={false} />
|
|
29
|
+
* ```
|
|
30
|
+
*/
|
|
31
|
+
animate?: boolean | PopupAnimation;
|
|
32
|
+
/**
|
|
33
|
+
* Specifies the element which will be used as an anchor ([see example](https://www.telerik.com/kendo-react-ui/components/popup/aligning-positioning)). The Popup opens next to that element.
|
|
34
|
+
*
|
|
35
|
+
* @example
|
|
36
|
+
* ```jsx
|
|
37
|
+
* <Popup anchor={document.getElementById('anchorElement')} />
|
|
38
|
+
* ```
|
|
39
|
+
*/
|
|
40
|
+
anchor?: HTMLElement | null;
|
|
41
|
+
/**
|
|
42
|
+
* Defines the container to which the Popup will be appended. Defaults to [`body`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/body).
|
|
43
|
+
* * If set to `null` the Popup will be rendered without React Portal.
|
|
44
|
+
*
|
|
45
|
+
* @default document.body
|
|
46
|
+
*
|
|
47
|
+
* @example
|
|
48
|
+
* ```jsx
|
|
49
|
+
* <Popup appendTo={document.getElementById('container')} />
|
|
50
|
+
* ```
|
|
51
|
+
*/
|
|
52
|
+
appendTo?: HTMLElement | null;
|
|
53
|
+
/**
|
|
54
|
+
* Specifies the pivot point of the anchor ([see example](https://www.telerik.com/kendo-react-ui/components/popup/aligning-positioning)).
|
|
55
|
+
*
|
|
56
|
+
* @example
|
|
57
|
+
* ```jsx
|
|
58
|
+
* <Popup anchorAlign={{ horizontal: 'left', vertical: 'top' }} />
|
|
59
|
+
* ```
|
|
60
|
+
*/
|
|
61
|
+
anchorAlign?: Align;
|
|
62
|
+
/**
|
|
63
|
+
* Configures the collision behavior of the Popup ([see example](https://www.telerik.com/kendo-react-ui/components/popup/viewport-boundary)).
|
|
64
|
+
*
|
|
65
|
+
* @example
|
|
66
|
+
* ```jsx
|
|
67
|
+
* <Popup collision={{ horizontal: 'fit', vertical: 'flip' }} />
|
|
68
|
+
* ```
|
|
69
|
+
*/
|
|
70
|
+
collision?: Collision;
|
|
71
|
+
/**
|
|
72
|
+
* Configures the margin value that will be added to the popup dimensions
|
|
73
|
+
* in pixels and leaves a blank space between the popup and the anchor.
|
|
74
|
+
*
|
|
75
|
+
* @example
|
|
76
|
+
* ```jsx
|
|
77
|
+
* <Popup margin={{ horizontal: 10, vertical: 10 }} />
|
|
78
|
+
* ```
|
|
79
|
+
*/
|
|
80
|
+
margin?: Margin;
|
|
81
|
+
/**
|
|
82
|
+
* Specifies the position mode of the component. By default, the Popup uses absolute positioning.
|
|
83
|
+
* To make the Popup acquire fixed positioning, set this option to `fixed`.
|
|
84
|
+
*
|
|
85
|
+
* @default "absolute"
|
|
86
|
+
*
|
|
87
|
+
* @example
|
|
88
|
+
* ```jsx
|
|
89
|
+
* <Popup positionMode="fixed" />
|
|
90
|
+
* ```
|
|
91
|
+
*/
|
|
92
|
+
positionMode?: PositionMode;
|
|
93
|
+
/**
|
|
94
|
+
* Used to set the document scale when using a [scale transform](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-function/scale).
|
|
95
|
+
*
|
|
96
|
+
* The document or container scale is required to compute the popup position correctly. Detecting the scale is not reliable and must be set by providing a value for SCALE.
|
|
97
|
+
*
|
|
98
|
+
* > Using this token is not necessary for user-applied browser zoom.
|
|
99
|
+
*
|
|
100
|
+
* @example
|
|
101
|
+
* ```jsx
|
|
102
|
+
* <Popup scale={1.5} />
|
|
103
|
+
* ```
|
|
104
|
+
*/
|
|
105
|
+
scale?: number;
|
|
106
|
+
/**
|
|
107
|
+
* Specifies the pivot point of the Popup ([see example](https://www.telerik.com/kendo-react-ui/components/popup/aligning-positioning)).
|
|
108
|
+
*
|
|
109
|
+
* @example
|
|
110
|
+
* ```jsx
|
|
111
|
+
* <Popup popupAlign={{ horizontal: 'center', vertical: 'bottom' }} />
|
|
112
|
+
* ```
|
|
113
|
+
*/
|
|
114
|
+
popupAlign?: Align;
|
|
115
|
+
/**
|
|
116
|
+
* Specifies the absolute position of the element ([see example](https://www.telerik.com/kendo-react-ui/components/popup/aligning-positioning)). The Popup opens next to that point. The pivot point of the Popup is defined by the `popupAlign` configuration option. The boundary detection is applied by using the window viewport.
|
|
117
|
+
*
|
|
118
|
+
* @example
|
|
119
|
+
* ```jsx
|
|
120
|
+
* <Popup offset={{ left: 100, top: 200 }} />
|
|
121
|
+
* ```
|
|
122
|
+
*/
|
|
123
|
+
offset?: Offset;
|
|
124
|
+
/**
|
|
125
|
+
* Specifies a list of CSS classes that will be added to the internal animated element ([see example](https://www.telerik.com/kendo-react-ui/components/popup/styling)).
|
|
126
|
+
*
|
|
127
|
+
* @example
|
|
128
|
+
* ```jsx
|
|
129
|
+
* <Popup popupClass="custom-popup-class" />
|
|
130
|
+
* ```
|
|
131
|
+
*/
|
|
132
|
+
popupClass?: string | Array<string> | {
|
|
133
|
+
[key: string]: boolean;
|
|
134
|
+
};
|
|
135
|
+
/**
|
|
136
|
+
* Specifies a list of CSS classes that will be added to the Popup element.
|
|
137
|
+
*
|
|
138
|
+
* @example
|
|
139
|
+
* ```jsx
|
|
140
|
+
* <Popup className="custom-class" />
|
|
141
|
+
* ```
|
|
142
|
+
*/
|
|
143
|
+
className?: string | Array<string>;
|
|
144
|
+
/**
|
|
145
|
+
* Specifies the id that will be added to the Popup element.
|
|
146
|
+
*
|
|
147
|
+
* @example
|
|
148
|
+
* ```jsx
|
|
149
|
+
* <Popup id="popup-id" />
|
|
150
|
+
* ```
|
|
151
|
+
*/
|
|
152
|
+
id?: string;
|
|
153
|
+
/**
|
|
154
|
+
* Represents the styles that are applied to the Popup.
|
|
155
|
+
*
|
|
156
|
+
* @example
|
|
157
|
+
* ```jsx
|
|
158
|
+
* <Popup style={{ width: '200px', height: '100px' }} />
|
|
159
|
+
* ```
|
|
160
|
+
*/
|
|
161
|
+
style?: React.CSSProperties;
|
|
162
|
+
/**
|
|
163
|
+
* Fires after the Popup is opened and the opening animation ends.
|
|
164
|
+
*
|
|
165
|
+
* @example
|
|
166
|
+
* ```jsx
|
|
167
|
+
* <Popup onOpen={(event) => console.log('Popup opened')} />
|
|
168
|
+
* ```
|
|
169
|
+
*/
|
|
170
|
+
onOpen?: (event: OpenEvent) => void;
|
|
171
|
+
/**
|
|
172
|
+
* Fires after the Popup is closed.
|
|
173
|
+
*
|
|
174
|
+
* @example
|
|
175
|
+
* ```jsx
|
|
176
|
+
* <Popup onClose={(event) => console.log('Popup closed')} />
|
|
177
|
+
* ```
|
|
178
|
+
*/
|
|
179
|
+
onClose?: (event: CloseEvent) => void;
|
|
180
|
+
/**
|
|
181
|
+
* Fires after the Popup position is set.
|
|
182
|
+
*
|
|
183
|
+
* @example
|
|
184
|
+
* ```jsx
|
|
185
|
+
* <Popup onPosition={(event) => console.log('Popup positioned')} />
|
|
186
|
+
* ```
|
|
187
|
+
*/
|
|
188
|
+
onPosition?: (event: PositionEvent) => void;
|
|
189
|
+
/**
|
|
190
|
+
* Fires when the mousedown event is triggered outside the Popup.
|
|
191
|
+
*
|
|
192
|
+
* @example
|
|
193
|
+
* ```jsx
|
|
194
|
+
* <Popup onMouseDownOutside={(event) => console.log('onMouseDownOutside')} />
|
|
195
|
+
* ```
|
|
196
|
+
*/
|
|
197
|
+
onMouseDownOutside?: (event: MouseDownOutsideEvent) => void;
|
|
198
|
+
/**
|
|
199
|
+
* Controls the Popup visibility ([see example](https://www.telerik.com/kendo-react-ui/components/popup/hidden-state)). Defaults to `false`.
|
|
200
|
+
*
|
|
201
|
+
* @default false
|
|
202
|
+
*
|
|
203
|
+
* @example
|
|
204
|
+
* ```jsx
|
|
205
|
+
* <Popup show={true} />
|
|
206
|
+
* ```
|
|
207
|
+
*/
|
|
208
|
+
show?: boolean;
|
|
209
|
+
/**
|
|
210
|
+
* @hidden
|
|
211
|
+
*
|
|
212
|
+
* If contentKey has changed, the popup will recalculate its position.
|
|
213
|
+
*/
|
|
214
|
+
contentKey?: any;
|
|
215
|
+
/**
|
|
216
|
+
* @hidden
|
|
217
|
+
*/
|
|
218
|
+
children?: React.ReactNode;
|
|
219
|
+
/**
|
|
220
|
+
* @hidden
|
|
221
|
+
*/
|
|
222
|
+
useBaseStyles?: boolean;
|
|
223
|
+
/**
|
|
224
|
+
* @hidden
|
|
225
|
+
*/
|
|
226
|
+
role?: string;
|
|
227
|
+
/**
|
|
228
|
+
* @hidden
|
|
229
|
+
*/
|
|
230
|
+
onKeyDown?: (event: React.KeyboardEvent) => void;
|
|
231
|
+
/**
|
|
232
|
+
* @hidden
|
|
233
|
+
*/
|
|
234
|
+
unstyled?: PopupClassStructure;
|
|
235
|
+
}
|
|
@@ -0,0 +1,93 @@
|
|
|
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 { Collision } from './Collision.js';
|
|
9
|
+
import { Align } from './Align.js';
|
|
10
|
+
import { OpenEvent, CloseEvent } from './Events.js';
|
|
11
|
+
import { Offset } from './Offset.js';
|
|
12
|
+
import { PopupAnimation } from './PopupAnimation.js';
|
|
13
|
+
import { Margin } from './Margin.js';
|
|
14
|
+
import { PositionMode } from './PositionMode.js';
|
|
15
|
+
import { PopupSettings as PopupSettingsBase } from '@progress/kendo-popup-common';
|
|
16
|
+
/**
|
|
17
|
+
* @hidden
|
|
18
|
+
*/
|
|
19
|
+
export interface PopupSettings extends PopupSettingsBase {
|
|
20
|
+
/**
|
|
21
|
+
* Controls the Popup animation ([see example](https://www.telerik.com/kendo-react-ui/components/popup/animations)). By default, the opening and closing animations are enabled.
|
|
22
|
+
*/
|
|
23
|
+
animate?: boolean | PopupAnimation;
|
|
24
|
+
/**
|
|
25
|
+
* Specifies the element which will be used as an anchor ([see example](https://www.telerik.com/kendo-react-ui/components/popup/aligning-positioning)). The Popup opens next to that element.
|
|
26
|
+
*/
|
|
27
|
+
anchor?: HTMLElement | null;
|
|
28
|
+
/**
|
|
29
|
+
* Defines the container to which the Popup will be appended. Defaults to [`body`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/body).
|
|
30
|
+
*/
|
|
31
|
+
appendTo?: HTMLElement | null;
|
|
32
|
+
/**
|
|
33
|
+
* Specifies the pivot point of the anchor ([see example](https://www.telerik.com/kendo-react-ui/components/popup/aligning-positioning)).
|
|
34
|
+
*/
|
|
35
|
+
anchorAlign?: Align;
|
|
36
|
+
/**
|
|
37
|
+
* Configures the collision behavior of the Popup ([see example](https://www.telerik.com/kendo-react-ui/components/popup/viewport-boundary)).
|
|
38
|
+
*/
|
|
39
|
+
collision?: Collision;
|
|
40
|
+
/**
|
|
41
|
+
* Configures the margin value that will be added to the popup dimensions
|
|
42
|
+
* in pixels and leaves a blank space between the popup and the anchor.
|
|
43
|
+
*/
|
|
44
|
+
margin?: Margin;
|
|
45
|
+
/**
|
|
46
|
+
* Specifies the position mode of the component. By default, the Popup uses abosolute positioning.
|
|
47
|
+
* To make the Popup acquire fixed positioning, set this option to `fixed`.
|
|
48
|
+
*
|
|
49
|
+
* > If you need to support mobile browsers with the zoom option, use the `absolute` positioning of the Popup.
|
|
50
|
+
*/
|
|
51
|
+
positionMode?: PositionMode;
|
|
52
|
+
/**
|
|
53
|
+
* Used to set the document scale when using a [scale transform](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-function/scale).
|
|
54
|
+
*
|
|
55
|
+
* The document or container scale is required to compute the popup position correctly. Detecting the scale is not reliable and must be set by providing a value for SCALE.
|
|
56
|
+
*
|
|
57
|
+
* > Using this token is not necessary for user-applied browser zoom.
|
|
58
|
+
*
|
|
59
|
+
*/
|
|
60
|
+
scale?: number;
|
|
61
|
+
/**
|
|
62
|
+
* Specifies the pivot point of the Popup ([see example](https://www.telerik.com/kendo-react-ui/components/popup/aligning-positioning)).
|
|
63
|
+
*/
|
|
64
|
+
popupAlign?: Align;
|
|
65
|
+
/**
|
|
66
|
+
* Specifies the absolute position of the element ([see example](https://www.telerik.com/kendo-react-ui/components/popup/aligning-positioning)). The Popup opens next to that point. The pivot point of the Popup is defined by the `popupAlign` configuration option. The boundary detection is applied by using the window viewport.
|
|
67
|
+
*/
|
|
68
|
+
offset?: Offset;
|
|
69
|
+
/**
|
|
70
|
+
* Specifies a list of CSS classes that will be added to the internal animated element ([see example](https://www.telerik.com/kendo-react-ui/components/popup/styling)).
|
|
71
|
+
*/
|
|
72
|
+
popupClass?: string | Array<string>;
|
|
73
|
+
/**
|
|
74
|
+
* Specifies a list of CSS classes that will be added to the Popup element.
|
|
75
|
+
*/
|
|
76
|
+
className?: string | Array<string>;
|
|
77
|
+
/**
|
|
78
|
+
* Specifies the id that will be added to the Popup element.
|
|
79
|
+
*/
|
|
80
|
+
id?: string;
|
|
81
|
+
/**
|
|
82
|
+
* Represents the styles that are applied to the Popup.
|
|
83
|
+
*/
|
|
84
|
+
style?: React.CSSProperties;
|
|
85
|
+
/**
|
|
86
|
+
* Fires after the Popup is opened and the opening animation ends.
|
|
87
|
+
*/
|
|
88
|
+
onOpen?: (event: OpenEvent) => void;
|
|
89
|
+
/**
|
|
90
|
+
* Fires after the Popup is closed.
|
|
91
|
+
*/
|
|
92
|
+
onClose?: (event: CloseEvent) => void;
|
|
93
|
+
}
|
|
@@ -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
|
+
import { PositionMode as PositionModeBase } from '@progress/kendo-popup-common';
|
|
9
|
+
/**
|
|
10
|
+
* The type which defines all possible position modes of the Popup.
|
|
11
|
+
*/
|
|
12
|
+
export type PositionMode = PositionModeBase;
|
|
@@ -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
|
+
import { PackageMetadata } from '@progress/kendo-licensing';
|
|
9
|
+
/**
|
|
10
|
+
* @hidden
|
|
11
|
+
*/
|
|
12
|
+
export declare const packageMetadata: PackageMetadata;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
// Generated file. DO NOT EDIT.
|
|
2
|
+
/**
|
|
3
|
+
* @hidden
|
|
4
|
+
*/
|
|
5
|
+
export const packageMetadata = Object.freeze({
|
|
6
|
+
name: '@progress/kendo-react-popup',
|
|
7
|
+
productName: 'KendoReact',
|
|
8
|
+
productCode: 'KENDOUIREACT',
|
|
9
|
+
productCodes: ['KENDOUIREACT'],
|
|
10
|
+
publishDate: 0,
|
|
11
|
+
version: '13.4.0-develop.2',
|
|
12
|
+
licensingDocsUrl: 'https://www.telerik.com/kendo-react-ui/components/my-license/'
|
|
13
|
+
});
|