@progress/kendo-react-tooltip 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/dist/cdn/js/kendo-react-tooltip.js +1 -1
- package/index.d.mts +20 -842
- package/index.d.ts +20 -842
- package/package-metadata.d.ts +12 -0
- package/package-metadata.mjs +13 -0
- package/package.json +10 -4
- package/popover/Popover.d.ts +22 -0
- package/popover/PopoverActionsBar.d.ts +26 -0
- package/popover/interfaces/Align.d.ts +31 -0
- package/popover/interfaces/PopoverActionsBarProps.d.ts +34 -0
- package/popover/interfaces/PopoverAnimation.d.ts +12 -0
- package/popover/interfaces/PopoverCloseEvent.d.ts +17 -0
- package/popover/interfaces/PopoverCollision.d.ts +21 -0
- package/popover/interfaces/PopoverCollisionType.d.ts +17 -0
- package/popover/interfaces/PopoverKeyDownEvent.d.ts +21 -0
- package/popover/interfaces/PopoverMargin.d.ts +21 -0
- package/popover/interfaces/PopoverOffset.d.ts +21 -0
- package/popover/interfaces/PopoverOpenEvent.d.ts +17 -0
- package/popover/interfaces/PopoverPosition.d.ts +16 -0
- package/popover/interfaces/PopoverPositionEvent.d.ts +25 -0
- package/popover/interfaces/PopoverPositionMode.d.ts +12 -0
- package/popover/interfaces/PopoverProps.d.ts +258 -0
- package/popover/utils.d.ts +19 -0
- package/tooltip/Tooltip.d.ts +111 -0
- package/tooltip/TooltipProps.d.ts +257 -0
- package/tooltip/events.d.ts +38 -0
- package/tooltip/utils.d.ts +46 -0
|
@@ -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-tooltip',
|
|
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
|
+
});
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@progress/kendo-react-tooltip",
|
|
3
|
-
"version": "13.
|
|
3
|
+
"version": "13.4.0-develop.2",
|
|
4
4
|
"description": "React Tooltips library represents popups with information that is related to a UI element. KendoReact Tooltips package",
|
|
5
5
|
"author": "Progress",
|
|
6
6
|
"license": "SEE LICENSE IN LICENSE.md",
|
|
@@ -26,8 +26,8 @@
|
|
|
26
26
|
"sideEffects": false,
|
|
27
27
|
"peerDependencies": {
|
|
28
28
|
"@progress/kendo-licensing": "^1.7.2",
|
|
29
|
-
"@progress/kendo-react-common": "13.
|
|
30
|
-
"@progress/kendo-react-popup": "13.
|
|
29
|
+
"@progress/kendo-react-common": "13.4.0-develop.2",
|
|
30
|
+
"@progress/kendo-react-popup": "13.4.0-develop.2",
|
|
31
31
|
"@progress/kendo-svg-icons": "^4.0.0",
|
|
32
32
|
"react": "^16.8.2 || ^17.0.0 || ^18.0.0 || ^19.0.0 || ^19.0.0-rc",
|
|
33
33
|
"react-dom": "^16.8.2 || ^17.0.0 || ^18.0.0 || ^19.0.0 || ^19.0.0-rc"
|
|
@@ -52,7 +52,13 @@
|
|
|
52
52
|
],
|
|
53
53
|
"@progress": {
|
|
54
54
|
"friendlyName": "Tooltip",
|
|
55
|
-
"framework": "KendoReact"
|
|
55
|
+
"framework": "KendoReact",
|
|
56
|
+
"package": {
|
|
57
|
+
"productName": "KendoReact",
|
|
58
|
+
"productCode": "KENDOUIREACT",
|
|
59
|
+
"publishDate": 1770288261,
|
|
60
|
+
"licensingDocsUrl": "https://www.telerik.com/kendo-react-ui/components/my-license/"
|
|
61
|
+
}
|
|
56
62
|
},
|
|
57
63
|
"repository": {
|
|
58
64
|
"type": "git",
|
|
@@ -0,0 +1,22 @@
|
|
|
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 { PopoverProps } from './interfaces/PopoverProps.js';
|
|
9
|
+
import * as React from 'react';
|
|
10
|
+
/**
|
|
11
|
+
* Represents the Object which is passed to the [`ref`](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom) callback of the Popover component.
|
|
12
|
+
*/
|
|
13
|
+
export interface PopoverHandle {
|
|
14
|
+
/**
|
|
15
|
+
* The props of the Popover.
|
|
16
|
+
*/
|
|
17
|
+
props: PopoverProps;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Represents the Popover component.
|
|
21
|
+
*/
|
|
22
|
+
export declare const Popover: React.ForwardRefExoticComponent<PopoverProps & React.RefAttributes<PopoverHandle | null>>;
|
|
@@ -0,0 +1,26 @@
|
|
|
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 { PopoverActionsBarProps } from './interfaces/PopoverActionsBarProps.js';
|
|
9
|
+
import * as React from 'react';
|
|
10
|
+
/**
|
|
11
|
+
* Represents the Object which is passed to the [`ref`](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom) callback of the PopoverActionBar component.
|
|
12
|
+
*/
|
|
13
|
+
export interface PopoverActionsBarHandle {
|
|
14
|
+
/**
|
|
15
|
+
* The props of the PopoverActionsBar.
|
|
16
|
+
*/
|
|
17
|
+
props: PopoverActionsBarProps;
|
|
18
|
+
/**
|
|
19
|
+
* The current element or `null` if there is none.
|
|
20
|
+
*/
|
|
21
|
+
element: HTMLDivElement | null;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Represents the PopoverActionsBar component.
|
|
25
|
+
*/
|
|
26
|
+
export declare const PopoverActionsBar: React.ForwardRefExoticComponent<PopoverActionsBarProps & React.RefAttributes<PopoverActionsBarHandle | null>>;
|
|
@@ -0,0 +1,31 @@
|
|
|
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 { Align as AlignBase } from '@progress/kendo-react-popup';
|
|
9
|
+
/**
|
|
10
|
+
* Defines the horizontal and vertical aligning point of the Popup.
|
|
11
|
+
*/
|
|
12
|
+
export interface Align extends AlignBase {
|
|
13
|
+
/**
|
|
14
|
+
* Defines the possible horizontal point values that are relative to the anchor or the Popup.
|
|
15
|
+
*
|
|
16
|
+
* The available options are:
|
|
17
|
+
* - `left`—Uses the leftmost point of the anchor element.
|
|
18
|
+
* - `center`—Uses the center point of the anchor element.
|
|
19
|
+
* - `right`—Uses the rightmost point of the anchor element.
|
|
20
|
+
*/
|
|
21
|
+
horizontal: 'left' | 'center' | 'right';
|
|
22
|
+
/**
|
|
23
|
+
* Defines the possible vertical point values that are relative to the anchor or the Popup.
|
|
24
|
+
*
|
|
25
|
+
* The available options are:
|
|
26
|
+
* - `top`—Uses the top point of the anchor element.
|
|
27
|
+
* - `center`—Uses the center point of the anchor element.
|
|
28
|
+
* - `bottom`—Uses the bottom point of the anchor element.
|
|
29
|
+
*/
|
|
30
|
+
vertical: 'top' | 'center' | 'bottom';
|
|
31
|
+
}
|
|
@@ -0,0 +1,34 @@
|
|
|
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
|
+
* Represents the props of the [KendoReact PopoverActionsBar](https://www.telerik.com/kendo-react-ui/components/tooltip/api/popoveractionsbar) component.
|
|
10
|
+
*/
|
|
11
|
+
export interface PopoverActionsBarProps {
|
|
12
|
+
/**
|
|
13
|
+
* Sets the horizontal alignment of the PopoverActionsBar buttons.
|
|
14
|
+
*
|
|
15
|
+
* The possible values are:
|
|
16
|
+
* * `start`
|
|
17
|
+
* * `center`
|
|
18
|
+
* * `end`
|
|
19
|
+
* * `stretched` (default)
|
|
20
|
+
*/
|
|
21
|
+
alignment?: string;
|
|
22
|
+
/**
|
|
23
|
+
* Sets the orientation of the PopoverActionsBar buttons.
|
|
24
|
+
*
|
|
25
|
+
* The possible values are:
|
|
26
|
+
* * `horizontal` (default)
|
|
27
|
+
* * `vertical`
|
|
28
|
+
*/
|
|
29
|
+
orientation?: string;
|
|
30
|
+
/**
|
|
31
|
+
* @hidden
|
|
32
|
+
*/
|
|
33
|
+
children?: React.ReactNode;
|
|
34
|
+
}
|
|
@@ -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 { PopupAnimation } from '@progress/kendo-react-popup';
|
|
9
|
+
/**
|
|
10
|
+
* The animation settings of the Popover.
|
|
11
|
+
*/
|
|
12
|
+
export type PopoverAnimation = PopupAnimation;
|
|
@@ -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 { PopoverHandle } from '../Popover.js';
|
|
9
|
+
/**
|
|
10
|
+
* Represents the object of the `Close` Popover event.
|
|
11
|
+
*/
|
|
12
|
+
export interface PopoverCloseEvent {
|
|
13
|
+
/**
|
|
14
|
+
* An event target.
|
|
15
|
+
*/
|
|
16
|
+
target: PopoverHandle;
|
|
17
|
+
}
|
|
@@ -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 { PopoverCollisionType } from './PopoverCollisionType.js';
|
|
9
|
+
/**
|
|
10
|
+
* Defines the horizontal and vertical collision behavior of the Popover.
|
|
11
|
+
*/
|
|
12
|
+
export interface PopoverCollision {
|
|
13
|
+
/**
|
|
14
|
+
* Defines the horizontal collision behavior of the Popover.
|
|
15
|
+
*/
|
|
16
|
+
horizontal: PopoverCollisionType;
|
|
17
|
+
/**
|
|
18
|
+
* Defines the vertical collision behavior of the Popover.
|
|
19
|
+
*/
|
|
20
|
+
vertical: PopoverCollisionType;
|
|
21
|
+
}
|
|
@@ -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-react-popup';
|
|
9
|
+
/**
|
|
10
|
+
* Defines the possible collision behavior when the Popover is not fully visible.
|
|
11
|
+
*
|
|
12
|
+
* The available options are:
|
|
13
|
+
* - `fit`—Moves the Popover horizontally until it is fully displayed in the viewport.
|
|
14
|
+
* - `flip`—Flips the Popover position based on the origin and the position properties.
|
|
15
|
+
* - `none`—The Popover is rendered at its original position. Usable when the Popover is focused on open and the page is scrolled to it.
|
|
16
|
+
*/
|
|
17
|
+
export type PopoverCollisionType = CollisionTypeBase;
|
|
@@ -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 { PopoverHandle } from '../Popover.js';
|
|
9
|
+
/**
|
|
10
|
+
* Represents the object of the `KeyDown` Popover event.
|
|
11
|
+
*/
|
|
12
|
+
export interface PopoverKeyDownEvent {
|
|
13
|
+
/**
|
|
14
|
+
* An event target.
|
|
15
|
+
*/
|
|
16
|
+
target: PopoverHandle;
|
|
17
|
+
/**
|
|
18
|
+
* A boolean value that indicates whether the Popover is visible.
|
|
19
|
+
*/
|
|
20
|
+
show?: boolean;
|
|
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 { Margin as MarginBase } from '@progress/kendo-react-popup';
|
|
9
|
+
/**
|
|
10
|
+
* Defines the horizontal and the vertical margin offset of the component.
|
|
11
|
+
*/
|
|
12
|
+
export interface PopoverMargin extends MarginBase {
|
|
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 { Offset as OffsetBase } from '@progress/kendo-react-popup';
|
|
9
|
+
/**
|
|
10
|
+
* The offset position of the Popover.
|
|
11
|
+
*/
|
|
12
|
+
export interface PopoverOffset extends OffsetBase {
|
|
13
|
+
/**
|
|
14
|
+
* Defines the top position of the Popover.
|
|
15
|
+
*/
|
|
16
|
+
top: number;
|
|
17
|
+
/**
|
|
18
|
+
* Defines the left position of the Popover.
|
|
19
|
+
*/
|
|
20
|
+
left: number;
|
|
21
|
+
}
|
|
@@ -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 { PopoverHandle } from '../Popover.js';
|
|
9
|
+
/**
|
|
10
|
+
* Represents the object of the `Open` Popover event.
|
|
11
|
+
*/
|
|
12
|
+
export interface PopoverOpenEvent {
|
|
13
|
+
/**
|
|
14
|
+
* An event target.
|
|
15
|
+
*/
|
|
16
|
+
target: PopoverHandle;
|
|
17
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
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 position of the Popover.
|
|
10
|
+
* The available options are:
|
|
11
|
+
* - `top`
|
|
12
|
+
* - `left`
|
|
13
|
+
* - `bottom`
|
|
14
|
+
* - `right`
|
|
15
|
+
*/
|
|
16
|
+
export type PopoverPosition = 'top' | 'left' | 'bottom' | 'right';
|
|
@@ -0,0 +1,25 @@
|
|
|
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 { PopoverHandle } from '../Popover.js';
|
|
9
|
+
/**
|
|
10
|
+
* Represents the object of the `Position` Popover event.
|
|
11
|
+
*/
|
|
12
|
+
export interface PopoverPositionEvent {
|
|
13
|
+
/**
|
|
14
|
+
* An event target.
|
|
15
|
+
*/
|
|
16
|
+
target: PopoverHandle;
|
|
17
|
+
/**
|
|
18
|
+
* Indicates if the position is fitted.
|
|
19
|
+
*/
|
|
20
|
+
fitted: boolean;
|
|
21
|
+
/**
|
|
22
|
+
* Indicates if the position is flipped.
|
|
23
|
+
*/
|
|
24
|
+
flipped: boolean;
|
|
25
|
+
}
|
|
@@ -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-react-popup';
|
|
9
|
+
/**
|
|
10
|
+
* The type which defines all possible position modes of the Popover.
|
|
11
|
+
*/
|
|
12
|
+
export type PopoverPositionMode = PositionModeBase;
|
|
@@ -0,0 +1,258 @@
|
|
|
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 { PopoverCollision } from './PopoverCollision.js';
|
|
9
|
+
import { PopoverMargin } from './PopoverMargin.js';
|
|
10
|
+
import { PopoverOffset } from './PopoverOffset.js';
|
|
11
|
+
import { PopoverOpenEvent } from './PopoverOpenEvent.js';
|
|
12
|
+
import { PopoverCloseEvent } from './PopoverCloseEvent.js';
|
|
13
|
+
import { PopoverAnimation } from './PopoverAnimation.js';
|
|
14
|
+
import { PopoverPosition } from './PopoverPosition.js';
|
|
15
|
+
import { PopoverPositionEvent } from './PopoverPositionEvent.js';
|
|
16
|
+
import { PopoverPositionMode } from './PopoverPositionMode.js';
|
|
17
|
+
import { PopoverKeyDownEvent } from './PopoverKeyDownEvent.js';
|
|
18
|
+
export interface PopoverProps {
|
|
19
|
+
/**
|
|
20
|
+
* Set the focus the Popover container automatically when mounted.
|
|
21
|
+
*
|
|
22
|
+
* @default true
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* ```jsx
|
|
26
|
+
* <Popover autoFocus={false} />
|
|
27
|
+
* ```
|
|
28
|
+
*/
|
|
29
|
+
autoFocus?: boolean;
|
|
30
|
+
/**
|
|
31
|
+
* Specifies the title of the Popover component.
|
|
32
|
+
* Can be a string or JSX content.
|
|
33
|
+
*
|
|
34
|
+
* @example
|
|
35
|
+
* ```jsx
|
|
36
|
+
* <Popover title="Popover Title" />
|
|
37
|
+
* ```
|
|
38
|
+
*/
|
|
39
|
+
title?: React.ReactNode;
|
|
40
|
+
/**
|
|
41
|
+
* Specifies the position of the Popover relative to the anchor or offset.
|
|
42
|
+
* Accepts predefined position values.
|
|
43
|
+
*
|
|
44
|
+
* @default "top"
|
|
45
|
+
*
|
|
46
|
+
* @example
|
|
47
|
+
* ```jsx
|
|
48
|
+
* <Popover position="top" />
|
|
49
|
+
* ```
|
|
50
|
+
*/
|
|
51
|
+
position?: PopoverPosition;
|
|
52
|
+
/**
|
|
53
|
+
* Controls the visibility of the Popover callout (arrow).
|
|
54
|
+
* If set to `false`, the callout will not be rendered.
|
|
55
|
+
*
|
|
56
|
+
* @default true
|
|
57
|
+
*
|
|
58
|
+
* @example
|
|
59
|
+
* ```jsx
|
|
60
|
+
* <Popover callout={false} />
|
|
61
|
+
* ```
|
|
62
|
+
*/
|
|
63
|
+
callout?: boolean;
|
|
64
|
+
/**
|
|
65
|
+
* Configures the animation behavior of the Popover.
|
|
66
|
+
* Accepts a boolean or a configuration object.
|
|
67
|
+
*
|
|
68
|
+
* @example
|
|
69
|
+
* ```jsx
|
|
70
|
+
* <Popover animate={true} />
|
|
71
|
+
* ```
|
|
72
|
+
*/
|
|
73
|
+
animate?: boolean | PopoverAnimation;
|
|
74
|
+
/**
|
|
75
|
+
* Specifies the element to be used as the anchor for the Popover.
|
|
76
|
+
* The Popover opens relative to this element.
|
|
77
|
+
*
|
|
78
|
+
* @example
|
|
79
|
+
* ```jsx
|
|
80
|
+
* <Popover anchor={document.getElementById('anchor')} />
|
|
81
|
+
* ```
|
|
82
|
+
*/
|
|
83
|
+
anchor?: HTMLElement | null;
|
|
84
|
+
/**
|
|
85
|
+
* Defines the container to which the Popover will be appended.
|
|
86
|
+
* Defaults to [`body`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/body).
|
|
87
|
+
* If set to `null`, the Popover will not use React Portal.
|
|
88
|
+
*
|
|
89
|
+
* @example
|
|
90
|
+
* ```jsx
|
|
91
|
+
* <Popover appendTo={document.getElementById('container')} />
|
|
92
|
+
* ```
|
|
93
|
+
*/
|
|
94
|
+
appendTo?: HTMLElement | null;
|
|
95
|
+
/**
|
|
96
|
+
* Configures the collision behavior of the Popover.
|
|
97
|
+
* Determines how the Popover adjusts its position when it overflows the viewport.
|
|
98
|
+
*
|
|
99
|
+
* @example
|
|
100
|
+
* ```jsx
|
|
101
|
+
* <Popover collision={{ horizontal: 'fit', vertical: 'flip' }} />
|
|
102
|
+
* ```
|
|
103
|
+
*/
|
|
104
|
+
collision?: PopoverCollision;
|
|
105
|
+
/**
|
|
106
|
+
* Specifies the margin in pixels between the Popover and the anchor element.
|
|
107
|
+
* Automatically set based on the `position` property if not specified.
|
|
108
|
+
*
|
|
109
|
+
* @example
|
|
110
|
+
* ```jsx
|
|
111
|
+
* <Popover margin={{ top: 10, left: 5 }} />
|
|
112
|
+
* ```
|
|
113
|
+
*/
|
|
114
|
+
margin?: PopoverMargin;
|
|
115
|
+
/**
|
|
116
|
+
* Specifies the positioning mode of the Popover.
|
|
117
|
+
* Defaults to `fixed`. Use `absolute` for mobile browser support with zoom.
|
|
118
|
+
*
|
|
119
|
+
* @default "fixed"
|
|
120
|
+
*
|
|
121
|
+
* @example
|
|
122
|
+
* ```jsx
|
|
123
|
+
* <Popover positionMode="absolute" />
|
|
124
|
+
* ```
|
|
125
|
+
*/
|
|
126
|
+
positionMode?: PopoverPositionMode;
|
|
127
|
+
/**
|
|
128
|
+
* Specifies the document scale when using a [scale transform](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-function/scale).
|
|
129
|
+
* Required for accurate positioning when scaling is applied.
|
|
130
|
+
*
|
|
131
|
+
* @example
|
|
132
|
+
* ```jsx
|
|
133
|
+
* <Popover scale={1.5} />
|
|
134
|
+
* ```
|
|
135
|
+
*/
|
|
136
|
+
scale?: number;
|
|
137
|
+
/**
|
|
138
|
+
* Specifies the absolute position of the Popover.
|
|
139
|
+
* The Popover opens relative to this point.
|
|
140
|
+
*
|
|
141
|
+
* @example
|
|
142
|
+
* ```jsx
|
|
143
|
+
* <Popover offset={{ top: 100, left: 200 }} />
|
|
144
|
+
* ```
|
|
145
|
+
*/
|
|
146
|
+
offset?: PopoverOffset;
|
|
147
|
+
/**
|
|
148
|
+
* Specifies additional CSS classes for the animated Popover element.
|
|
149
|
+
*
|
|
150
|
+
* @example
|
|
151
|
+
* ```jsx
|
|
152
|
+
* <Popover popoverClass="custom-popover-class" />
|
|
153
|
+
* ```
|
|
154
|
+
*/
|
|
155
|
+
popoverClass?: string | Array<string> | {
|
|
156
|
+
[key: string]: boolean;
|
|
157
|
+
};
|
|
158
|
+
/**
|
|
159
|
+
* Specifies additional CSS classes for the Popover element.
|
|
160
|
+
*
|
|
161
|
+
* @example
|
|
162
|
+
* ```jsx
|
|
163
|
+
* <Popover className="custom-class" />
|
|
164
|
+
* ```
|
|
165
|
+
*/
|
|
166
|
+
className?: string | Array<string>;
|
|
167
|
+
/**
|
|
168
|
+
* Specifies the `id` attribute for the Popover element.
|
|
169
|
+
*
|
|
170
|
+
* @example
|
|
171
|
+
* ```jsx
|
|
172
|
+
* <Popover id="popover-id" />
|
|
173
|
+
* ```
|
|
174
|
+
*/
|
|
175
|
+
id?: string;
|
|
176
|
+
/**
|
|
177
|
+
* Specifies the styles applied to the Popover element.
|
|
178
|
+
*
|
|
179
|
+
* @example
|
|
180
|
+
* ```jsx
|
|
181
|
+
* <Popover style={{ backgroundColor: 'blue' }} />
|
|
182
|
+
* ```
|
|
183
|
+
*/
|
|
184
|
+
style?: React.CSSProperties;
|
|
185
|
+
/**
|
|
186
|
+
* Specifies the styles applied to the content element of the Popover.
|
|
187
|
+
*
|
|
188
|
+
* @example
|
|
189
|
+
* ```jsx
|
|
190
|
+
* <Popover contentStyle={{ padding: '10px' }} />
|
|
191
|
+
* ```
|
|
192
|
+
*/
|
|
193
|
+
contentStyle?: React.CSSProperties;
|
|
194
|
+
/**
|
|
195
|
+
* Controls the visibility of the Popover.
|
|
196
|
+
* Defaults to `false`.
|
|
197
|
+
*
|
|
198
|
+
* @default false
|
|
199
|
+
*
|
|
200
|
+
* @example
|
|
201
|
+
* ```jsx
|
|
202
|
+
* <Popover show={true} />
|
|
203
|
+
* ```
|
|
204
|
+
*/
|
|
205
|
+
show?: boolean;
|
|
206
|
+
/**
|
|
207
|
+
* Fires after the Popover is opened and the opening animation ends.
|
|
208
|
+
* Provides the event details.
|
|
209
|
+
*
|
|
210
|
+
* @example
|
|
211
|
+
* ```jsx
|
|
212
|
+
* <Popover onOpen={(event) => console.log('Popover opened', event)} />
|
|
213
|
+
* ```
|
|
214
|
+
*/
|
|
215
|
+
onOpen?: (event: PopoverOpenEvent) => void;
|
|
216
|
+
/**
|
|
217
|
+
* Fires after the Popover is closed.
|
|
218
|
+
* Provides the event details.
|
|
219
|
+
*
|
|
220
|
+
* @example
|
|
221
|
+
* ```jsx
|
|
222
|
+
* <Popover onClose={(event) => console.log('Popover closed', event)} />
|
|
223
|
+
* ```
|
|
224
|
+
*/
|
|
225
|
+
onClose?: (event: PopoverCloseEvent) => void;
|
|
226
|
+
/**
|
|
227
|
+
* Fires after the Popover position is calculated and set.
|
|
228
|
+
* Provides the event details.
|
|
229
|
+
*
|
|
230
|
+
* @example
|
|
231
|
+
* ```jsx
|
|
232
|
+
* <Popover onPosition={(event) => console.log('Popover positioned', event)} />
|
|
233
|
+
* ```
|
|
234
|
+
*/
|
|
235
|
+
onPosition?: (event: PopoverPositionEvent) => void;
|
|
236
|
+
/**
|
|
237
|
+
* Fires when the Popover is focused and a key is pressed.
|
|
238
|
+
* Provides the event details.
|
|
239
|
+
*
|
|
240
|
+
* @example
|
|
241
|
+
* ```jsx
|
|
242
|
+
* <Popover onKeyDown={(event) => console.log('Key pressed', event)} />
|
|
243
|
+
* ```
|
|
244
|
+
*/
|
|
245
|
+
onKeyDown?: (event: PopoverKeyDownEvent) => void;
|
|
246
|
+
/**
|
|
247
|
+
* Specifies the children elements of the Popover.
|
|
248
|
+
* Used to define the content of the Popover.
|
|
249
|
+
*
|
|
250
|
+
* @example
|
|
251
|
+
* ```jsx
|
|
252
|
+
* <Popover>
|
|
253
|
+
* <div>Popover Content</div>
|
|
254
|
+
* </Popover>
|
|
255
|
+
* ```
|
|
256
|
+
*/
|
|
257
|
+
children?: React.ReactNode;
|
|
258
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
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
|
+
* @hidden
|
|
10
|
+
*/
|
|
11
|
+
export declare const getFirstFocusableElement: (element: HTMLElement) => HTMLElement | undefined;
|
|
12
|
+
/**
|
|
13
|
+
* @hidden
|
|
14
|
+
*/
|
|
15
|
+
export declare const getLastFocusableElement: (element: HTMLElement) => HTMLElement | undefined;
|
|
16
|
+
/**
|
|
17
|
+
* @hidden
|
|
18
|
+
*/
|
|
19
|
+
export declare const handleFocusTrap: (e: KeyboardEvent) => void;
|