@versini/ui-tooltip 6.3.0 → 6.3.1
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/index.d.ts +55 -52
- package/dist/index.js +1 -1
- package/package.json +2 -2
package/dist/index.d.ts
CHANGED
|
@@ -2,66 +2,69 @@ import { JSX } from 'react';
|
|
|
2
2
|
|
|
3
3
|
declare type Placement = "top" | "right" | "bottom" | "left" | "top-start" | "top-end" | "right-start" | "right-end" | "bottom-start" | "bottom-end" | "left-start" | "left-end";
|
|
4
4
|
|
|
5
|
-
export declare const Tooltip: ({ trigger, label, placement, mode, animationDuration, delay, className, tooltipClassName, arrowClassName, }:
|
|
5
|
+
export declare const Tooltip: ({ trigger, label, placement, mode, animationDuration, delay, className, tooltipClassName, arrowClassName, }: TooltipProps) => JSX.Element;
|
|
6
6
|
|
|
7
7
|
export declare const TOOLTIP_ARROW_CLASSNAME = "av-tooltip-arrow";
|
|
8
8
|
|
|
9
9
|
export declare const TOOLTIP_CLASSNAME = "av-tooltip";
|
|
10
10
|
|
|
11
|
+
export declare type TooltipProps = {
|
|
12
|
+
/**
|
|
13
|
+
* CSS class(es) to add to the main component wrapper. This is different from
|
|
14
|
+
* the tooltip itself and should be used to style the main component wrapper,
|
|
15
|
+
* such as margins, padding, etc.
|
|
16
|
+
*/
|
|
17
|
+
className?: string;
|
|
18
|
+
/**
|
|
19
|
+
* CSS class(es) to add to the tooltip. This is different from the main
|
|
20
|
+
* component wrapper and should be used to style the tooltip itself, such as
|
|
21
|
+
* background color, text color, etc.
|
|
22
|
+
*/
|
|
23
|
+
tooltipClassName?: string;
|
|
24
|
+
/**
|
|
25
|
+
* CSS class(es) to add to the arrow portion of the tooltip.
|
|
26
|
+
*/
|
|
27
|
+
arrowClassName?: string;
|
|
28
|
+
/**
|
|
29
|
+
* The label to show in the tooltip.
|
|
30
|
+
*/
|
|
31
|
+
label: string;
|
|
32
|
+
/**
|
|
33
|
+
* The trigger element for the tooltip.
|
|
34
|
+
*/
|
|
35
|
+
trigger: React.ReactNode;
|
|
36
|
+
/**
|
|
37
|
+
* The placement of the tooltip.
|
|
38
|
+
* @default top
|
|
39
|
+
*/
|
|
40
|
+
placement?: Placement;
|
|
41
|
+
/**
|
|
42
|
+
* The mode of tooltip. This will change the color of the tooltip.
|
|
43
|
+
*/
|
|
44
|
+
mode?: "dark" | "light" | "system" | "alt-system";
|
|
45
|
+
/**
|
|
46
|
+
* The duration in milliseconds of the tooltip fade-in animation.
|
|
47
|
+
* @default 300
|
|
48
|
+
*/
|
|
49
|
+
animationDuration?: number;
|
|
50
|
+
/**
|
|
51
|
+
* The delay in milliseconds before showing the tooltip after hovering.
|
|
52
|
+
* @default 0
|
|
53
|
+
*/
|
|
54
|
+
delay?: number;
|
|
55
|
+
};
|
|
56
|
+
|
|
11
57
|
/**
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
58
|
+
* Compatibility shim left over from the retired `@versini/ui-types`. The flat
|
|
59
|
+
* `TooltipProps` above is the house convention and the canonical definition;
|
|
60
|
+
* this namespace only aliases it. See "Props type naming" in CLAUDE.md. Removal
|
|
61
|
+
* is tracked in versini-org/ui-components#1990.
|
|
16
62
|
*/
|
|
17
|
-
export declare type TooltipProps = TooltipTypes.Props;
|
|
18
|
-
|
|
19
63
|
export declare namespace TooltipTypes {
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
* such as margins, padding, etc.
|
|
25
|
-
*/
|
|
26
|
-
className?: string;
|
|
27
|
-
/**
|
|
28
|
-
* CSS class(es) to add to the tooltip. This is different from the main
|
|
29
|
-
* component wrapper and should be used to style the tooltip itself, such as
|
|
30
|
-
* background color, text color, etc.
|
|
31
|
-
*/
|
|
32
|
-
tooltipClassName?: string;
|
|
33
|
-
/**
|
|
34
|
-
* CSS class(es) to add to the arrow portion of the tooltip.
|
|
35
|
-
*/
|
|
36
|
-
arrowClassName?: string;
|
|
37
|
-
/**
|
|
38
|
-
* The label to show in the tooltip.
|
|
39
|
-
*/
|
|
40
|
-
label: string;
|
|
41
|
-
/**
|
|
42
|
-
* The trigger element for the tooltip.
|
|
43
|
-
*/
|
|
44
|
-
trigger: React.ReactNode;
|
|
45
|
-
/**
|
|
46
|
-
* The placement of the tooltip.
|
|
47
|
-
* @default top
|
|
48
|
-
*/
|
|
49
|
-
placement?: Placement;
|
|
50
|
-
/**
|
|
51
|
-
* The mode of tooltip. This will change the color of the tooltip.
|
|
52
|
-
*/
|
|
53
|
-
mode?: "dark" | "light" | "system" | "alt-system";
|
|
54
|
-
/**
|
|
55
|
-
* The duration in milliseconds of the tooltip fade-in animation.
|
|
56
|
-
* @default 300
|
|
57
|
-
*/
|
|
58
|
-
animationDuration?: number;
|
|
59
|
-
/**
|
|
60
|
-
* The delay in milliseconds before showing the tooltip after hovering.
|
|
61
|
-
* @default 0
|
|
62
|
-
*/
|
|
63
|
-
delay?: number;
|
|
64
|
-
};
|
|
64
|
+
/**
|
|
65
|
+
* @deprecated Use `TooltipProps` instead.
|
|
66
|
+
*/
|
|
67
|
+
export type Props = TooltipProps;
|
|
65
68
|
}
|
|
66
69
|
|
|
67
70
|
export { }
|
package/dist/index.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@versini/ui-tooltip",
|
|
3
|
-
"version": "6.3.
|
|
3
|
+
"version": "6.3.1",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"author": "Arno Versini",
|
|
6
6
|
"publishConfig": {
|
|
@@ -50,5 +50,5 @@
|
|
|
50
50
|
"peerDependencies": {
|
|
51
51
|
"react": "^19.0.0"
|
|
52
52
|
},
|
|
53
|
-
"gitHead": "
|
|
53
|
+
"gitHead": "065479294f4135e164fcf2df90219feb169104f7"
|
|
54
54
|
}
|