@radix-ui/react-tooltip 0.0.0-20250116175529
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/README.md +13 -0
- package/dist/index.d.mts +101 -0
- package/dist/index.d.ts +101 -0
- package/dist/index.js +533 -0
- package/dist/index.js.map +7 -0
- package/dist/index.mjs +501 -0
- package/dist/index.mjs.map +7 -0
- package/package.json +65 -0
package/README.md
ADDED
package/dist/index.d.mts
ADDED
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
import * as _radix_ui_react_context from '@radix-ui/react-context';
|
|
2
|
+
import * as React from 'react';
|
|
3
|
+
import { DismissableLayer } from '@radix-ui/react-dismissable-layer';
|
|
4
|
+
import * as PopperPrimitive from '@radix-ui/react-popper';
|
|
5
|
+
import { Portal as Portal$1 } from '@radix-ui/react-portal';
|
|
6
|
+
import { Primitive } from '@radix-ui/react-primitive';
|
|
7
|
+
|
|
8
|
+
declare const createTooltipScope: _radix_ui_react_context.CreateScope;
|
|
9
|
+
interface TooltipProviderProps {
|
|
10
|
+
children: React.ReactNode;
|
|
11
|
+
/**
|
|
12
|
+
* The duration from when the pointer enters the trigger until the tooltip gets opened.
|
|
13
|
+
* @defaultValue 700
|
|
14
|
+
*/
|
|
15
|
+
delayDuration?: number;
|
|
16
|
+
/**
|
|
17
|
+
* How much time a user has to enter another trigger without incurring a delay again.
|
|
18
|
+
* @defaultValue 300
|
|
19
|
+
*/
|
|
20
|
+
skipDelayDuration?: number;
|
|
21
|
+
/**
|
|
22
|
+
* When `true`, trying to hover the content will result in the tooltip closing as the pointer leaves the trigger.
|
|
23
|
+
* @defaultValue false
|
|
24
|
+
*/
|
|
25
|
+
disableHoverableContent?: boolean;
|
|
26
|
+
}
|
|
27
|
+
declare const TooltipProvider: React.FC<TooltipProviderProps>;
|
|
28
|
+
interface TooltipProps {
|
|
29
|
+
children?: React.ReactNode;
|
|
30
|
+
open?: boolean;
|
|
31
|
+
defaultOpen?: boolean;
|
|
32
|
+
onOpenChange?: (open: boolean) => void;
|
|
33
|
+
/**
|
|
34
|
+
* The duration from when the pointer enters the trigger until the tooltip gets opened. This will
|
|
35
|
+
* override the prop with the same name passed to Provider.
|
|
36
|
+
* @defaultValue 700
|
|
37
|
+
*/
|
|
38
|
+
delayDuration?: number;
|
|
39
|
+
/**
|
|
40
|
+
* When `true`, trying to hover the content will result in the tooltip closing as the pointer leaves the trigger.
|
|
41
|
+
* @defaultValue false
|
|
42
|
+
*/
|
|
43
|
+
disableHoverableContent?: boolean;
|
|
44
|
+
}
|
|
45
|
+
declare const Tooltip: React.FC<TooltipProps>;
|
|
46
|
+
type PrimitiveButtonProps = React.ComponentPropsWithoutRef<typeof Primitive.button>;
|
|
47
|
+
interface TooltipTriggerProps extends PrimitiveButtonProps {
|
|
48
|
+
}
|
|
49
|
+
declare const TooltipTrigger: React.ForwardRefExoticComponent<TooltipTriggerProps & React.RefAttributes<HTMLButtonElement>>;
|
|
50
|
+
type PortalProps = React.ComponentPropsWithoutRef<typeof Portal$1>;
|
|
51
|
+
interface TooltipPortalProps {
|
|
52
|
+
children?: React.ReactNode;
|
|
53
|
+
/**
|
|
54
|
+
* Specify a container element to portal the content into.
|
|
55
|
+
*/
|
|
56
|
+
container?: PortalProps['container'];
|
|
57
|
+
/**
|
|
58
|
+
* Used to force mounting when more control is needed. Useful when
|
|
59
|
+
* controlling animation with React animation libraries.
|
|
60
|
+
*/
|
|
61
|
+
forceMount?: true;
|
|
62
|
+
}
|
|
63
|
+
declare const TooltipPortal: React.FC<TooltipPortalProps>;
|
|
64
|
+
interface TooltipContentProps extends TooltipContentImplProps {
|
|
65
|
+
/**
|
|
66
|
+
* Used to force mounting when more control is needed. Useful when
|
|
67
|
+
* controlling animation with React animation libraries.
|
|
68
|
+
*/
|
|
69
|
+
forceMount?: true;
|
|
70
|
+
}
|
|
71
|
+
declare const TooltipContent: React.ForwardRefExoticComponent<TooltipContentProps & React.RefAttributes<HTMLDivElement>>;
|
|
72
|
+
type DismissableLayerProps = React.ComponentPropsWithoutRef<typeof DismissableLayer>;
|
|
73
|
+
type PopperContentProps = React.ComponentPropsWithoutRef<typeof PopperPrimitive.Content>;
|
|
74
|
+
interface TooltipContentImplProps extends Omit<PopperContentProps, 'onPlaced'> {
|
|
75
|
+
/**
|
|
76
|
+
* A more descriptive label for accessibility purpose
|
|
77
|
+
*/
|
|
78
|
+
'aria-label'?: string;
|
|
79
|
+
/**
|
|
80
|
+
* Event handler called when the escape key is down.
|
|
81
|
+
* Can be prevented.
|
|
82
|
+
*/
|
|
83
|
+
onEscapeKeyDown?: DismissableLayerProps['onEscapeKeyDown'];
|
|
84
|
+
/**
|
|
85
|
+
* Event handler called when the a `pointerdown` event happens outside of the `Tooltip`.
|
|
86
|
+
* Can be prevented.
|
|
87
|
+
*/
|
|
88
|
+
onPointerDownOutside?: DismissableLayerProps['onPointerDownOutside'];
|
|
89
|
+
}
|
|
90
|
+
type PopperArrowProps = React.ComponentPropsWithoutRef<typeof PopperPrimitive.Arrow>;
|
|
91
|
+
interface TooltipArrowProps extends PopperArrowProps {
|
|
92
|
+
}
|
|
93
|
+
declare const TooltipArrow: React.ForwardRefExoticComponent<TooltipArrowProps & React.RefAttributes<SVGSVGElement>>;
|
|
94
|
+
declare const Provider: React.FC<TooltipProviderProps>;
|
|
95
|
+
declare const Root: React.FC<TooltipProps>;
|
|
96
|
+
declare const Trigger: React.ForwardRefExoticComponent<TooltipTriggerProps & React.RefAttributes<HTMLButtonElement>>;
|
|
97
|
+
declare const Portal: React.FC<TooltipPortalProps>;
|
|
98
|
+
declare const Content: React.ForwardRefExoticComponent<TooltipContentProps & React.RefAttributes<HTMLDivElement>>;
|
|
99
|
+
declare const Arrow: React.ForwardRefExoticComponent<TooltipArrowProps & React.RefAttributes<SVGSVGElement>>;
|
|
100
|
+
|
|
101
|
+
export { Arrow, Content, Portal, Provider, Root, Tooltip, TooltipArrow, type TooltipArrowProps, TooltipContent, type TooltipContentProps, TooltipPortal, type TooltipPortalProps, type TooltipProps, TooltipProvider, type TooltipProviderProps, TooltipTrigger, type TooltipTriggerProps, Trigger, createTooltipScope };
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
import * as _radix_ui_react_context from '@radix-ui/react-context';
|
|
2
|
+
import * as React from 'react';
|
|
3
|
+
import { DismissableLayer } from '@radix-ui/react-dismissable-layer';
|
|
4
|
+
import * as PopperPrimitive from '@radix-ui/react-popper';
|
|
5
|
+
import { Portal as Portal$1 } from '@radix-ui/react-portal';
|
|
6
|
+
import { Primitive } from '@radix-ui/react-primitive';
|
|
7
|
+
|
|
8
|
+
declare const createTooltipScope: _radix_ui_react_context.CreateScope;
|
|
9
|
+
interface TooltipProviderProps {
|
|
10
|
+
children: React.ReactNode;
|
|
11
|
+
/**
|
|
12
|
+
* The duration from when the pointer enters the trigger until the tooltip gets opened.
|
|
13
|
+
* @defaultValue 700
|
|
14
|
+
*/
|
|
15
|
+
delayDuration?: number;
|
|
16
|
+
/**
|
|
17
|
+
* How much time a user has to enter another trigger without incurring a delay again.
|
|
18
|
+
* @defaultValue 300
|
|
19
|
+
*/
|
|
20
|
+
skipDelayDuration?: number;
|
|
21
|
+
/**
|
|
22
|
+
* When `true`, trying to hover the content will result in the tooltip closing as the pointer leaves the trigger.
|
|
23
|
+
* @defaultValue false
|
|
24
|
+
*/
|
|
25
|
+
disableHoverableContent?: boolean;
|
|
26
|
+
}
|
|
27
|
+
declare const TooltipProvider: React.FC<TooltipProviderProps>;
|
|
28
|
+
interface TooltipProps {
|
|
29
|
+
children?: React.ReactNode;
|
|
30
|
+
open?: boolean;
|
|
31
|
+
defaultOpen?: boolean;
|
|
32
|
+
onOpenChange?: (open: boolean) => void;
|
|
33
|
+
/**
|
|
34
|
+
* The duration from when the pointer enters the trigger until the tooltip gets opened. This will
|
|
35
|
+
* override the prop with the same name passed to Provider.
|
|
36
|
+
* @defaultValue 700
|
|
37
|
+
*/
|
|
38
|
+
delayDuration?: number;
|
|
39
|
+
/**
|
|
40
|
+
* When `true`, trying to hover the content will result in the tooltip closing as the pointer leaves the trigger.
|
|
41
|
+
* @defaultValue false
|
|
42
|
+
*/
|
|
43
|
+
disableHoverableContent?: boolean;
|
|
44
|
+
}
|
|
45
|
+
declare const Tooltip: React.FC<TooltipProps>;
|
|
46
|
+
type PrimitiveButtonProps = React.ComponentPropsWithoutRef<typeof Primitive.button>;
|
|
47
|
+
interface TooltipTriggerProps extends PrimitiveButtonProps {
|
|
48
|
+
}
|
|
49
|
+
declare const TooltipTrigger: React.ForwardRefExoticComponent<TooltipTriggerProps & React.RefAttributes<HTMLButtonElement>>;
|
|
50
|
+
type PortalProps = React.ComponentPropsWithoutRef<typeof Portal$1>;
|
|
51
|
+
interface TooltipPortalProps {
|
|
52
|
+
children?: React.ReactNode;
|
|
53
|
+
/**
|
|
54
|
+
* Specify a container element to portal the content into.
|
|
55
|
+
*/
|
|
56
|
+
container?: PortalProps['container'];
|
|
57
|
+
/**
|
|
58
|
+
* Used to force mounting when more control is needed. Useful when
|
|
59
|
+
* controlling animation with React animation libraries.
|
|
60
|
+
*/
|
|
61
|
+
forceMount?: true;
|
|
62
|
+
}
|
|
63
|
+
declare const TooltipPortal: React.FC<TooltipPortalProps>;
|
|
64
|
+
interface TooltipContentProps extends TooltipContentImplProps {
|
|
65
|
+
/**
|
|
66
|
+
* Used to force mounting when more control is needed. Useful when
|
|
67
|
+
* controlling animation with React animation libraries.
|
|
68
|
+
*/
|
|
69
|
+
forceMount?: true;
|
|
70
|
+
}
|
|
71
|
+
declare const TooltipContent: React.ForwardRefExoticComponent<TooltipContentProps & React.RefAttributes<HTMLDivElement>>;
|
|
72
|
+
type DismissableLayerProps = React.ComponentPropsWithoutRef<typeof DismissableLayer>;
|
|
73
|
+
type PopperContentProps = React.ComponentPropsWithoutRef<typeof PopperPrimitive.Content>;
|
|
74
|
+
interface TooltipContentImplProps extends Omit<PopperContentProps, 'onPlaced'> {
|
|
75
|
+
/**
|
|
76
|
+
* A more descriptive label for accessibility purpose
|
|
77
|
+
*/
|
|
78
|
+
'aria-label'?: string;
|
|
79
|
+
/**
|
|
80
|
+
* Event handler called when the escape key is down.
|
|
81
|
+
* Can be prevented.
|
|
82
|
+
*/
|
|
83
|
+
onEscapeKeyDown?: DismissableLayerProps['onEscapeKeyDown'];
|
|
84
|
+
/**
|
|
85
|
+
* Event handler called when the a `pointerdown` event happens outside of the `Tooltip`.
|
|
86
|
+
* Can be prevented.
|
|
87
|
+
*/
|
|
88
|
+
onPointerDownOutside?: DismissableLayerProps['onPointerDownOutside'];
|
|
89
|
+
}
|
|
90
|
+
type PopperArrowProps = React.ComponentPropsWithoutRef<typeof PopperPrimitive.Arrow>;
|
|
91
|
+
interface TooltipArrowProps extends PopperArrowProps {
|
|
92
|
+
}
|
|
93
|
+
declare const TooltipArrow: React.ForwardRefExoticComponent<TooltipArrowProps & React.RefAttributes<SVGSVGElement>>;
|
|
94
|
+
declare const Provider: React.FC<TooltipProviderProps>;
|
|
95
|
+
declare const Root: React.FC<TooltipProps>;
|
|
96
|
+
declare const Trigger: React.ForwardRefExoticComponent<TooltipTriggerProps & React.RefAttributes<HTMLButtonElement>>;
|
|
97
|
+
declare const Portal: React.FC<TooltipPortalProps>;
|
|
98
|
+
declare const Content: React.ForwardRefExoticComponent<TooltipContentProps & React.RefAttributes<HTMLDivElement>>;
|
|
99
|
+
declare const Arrow: React.ForwardRefExoticComponent<TooltipArrowProps & React.RefAttributes<SVGSVGElement>>;
|
|
100
|
+
|
|
101
|
+
export { Arrow, Content, Portal, Provider, Root, Tooltip, TooltipArrow, type TooltipArrowProps, TooltipContent, type TooltipContentProps, TooltipPortal, type TooltipPortalProps, type TooltipProps, TooltipProvider, type TooltipProviderProps, TooltipTrigger, type TooltipTriggerProps, Trigger, createTooltipScope };
|