@dxos/react-ui 0.8.1 → 0.8.2-main.10c050d

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.
Files changed (135) hide show
  1. package/dist/lib/browser/chunk-5Y5JI6KC.mjs +4355 -0
  2. package/dist/lib/browser/chunk-5Y5JI6KC.mjs.map +7 -0
  3. package/dist/lib/browser/index.mjs +75 -2986
  4. package/dist/lib/browser/index.mjs.map +4 -4
  5. package/dist/lib/browser/meta.json +1 -1
  6. package/dist/lib/browser/testing/index.mjs +85 -0
  7. package/dist/lib/browser/testing/index.mjs.map +7 -0
  8. package/dist/lib/node/chunk-KMS7RFL7.cjs +4340 -0
  9. package/dist/lib/node/chunk-KMS7RFL7.cjs.map +7 -0
  10. package/dist/lib/node/index.cjs +71 -2946
  11. package/dist/lib/node/index.cjs.map +4 -4
  12. package/dist/lib/node/meta.json +1 -1
  13. package/dist/lib/node/testing/index.cjs +114 -0
  14. package/dist/lib/node/testing/index.cjs.map +7 -0
  15. package/dist/lib/node-esm/chunk-ANVE7WX5.mjs +4357 -0
  16. package/dist/lib/node-esm/chunk-ANVE7WX5.mjs.map +7 -0
  17. package/dist/lib/node-esm/index.mjs +74 -2986
  18. package/dist/lib/node-esm/index.mjs.map +4 -4
  19. package/dist/lib/node-esm/meta.json +1 -1
  20. package/dist/lib/node-esm/testing/index.mjs +86 -0
  21. package/dist/lib/node-esm/testing/index.mjs.map +7 -0
  22. package/dist/types/src/components/Avatars/Avatar.d.ts +4 -4
  23. package/dist/types/src/components/Avatars/Avatar.d.ts.map +1 -1
  24. package/dist/types/src/components/Avatars/Avatar.stories.d.ts +3 -3
  25. package/dist/types/src/components/Avatars/Avatar.stories.d.ts.map +1 -1
  26. package/dist/types/src/components/Avatars/AvatarGroup.stories.d.ts +0 -1
  27. package/dist/types/src/components/Avatars/AvatarGroup.stories.d.ts.map +1 -1
  28. package/dist/types/src/components/Buttons/Button.stories.d.ts +10 -44
  29. package/dist/types/src/components/Buttons/Button.stories.d.ts.map +1 -1
  30. package/dist/types/src/components/Buttons/IconButton.d.ts +4 -6
  31. package/dist/types/src/components/Buttons/IconButton.d.ts.map +1 -1
  32. package/dist/types/src/components/Buttons/IconButton.stories.d.ts +7 -6
  33. package/dist/types/src/components/Buttons/IconButton.stories.d.ts.map +1 -1
  34. package/dist/types/src/components/Buttons/Toggle.stories.d.ts.map +1 -1
  35. package/dist/types/src/components/Buttons/ToggleGroup.stories.d.ts +1 -4
  36. package/dist/types/src/components/Buttons/ToggleGroup.stories.d.ts.map +1 -1
  37. package/dist/types/src/components/Clipboard/ClipboardProvider.d.ts.map +1 -1
  38. package/dist/types/src/components/Clipboard/CopyButton.d.ts +2 -1
  39. package/dist/types/src/components/Clipboard/CopyButton.d.ts.map +1 -1
  40. package/dist/types/src/components/Clipboard/index.d.ts +2 -2
  41. package/dist/types/src/components/DensityProvider/DensityProvider.d.ts.map +1 -1
  42. package/dist/types/src/components/Dialogs/AlertDialog.stories.d.ts +2 -2
  43. package/dist/types/src/components/Dialogs/AlertDialog.stories.d.ts.map +1 -1
  44. package/dist/types/src/components/Dialogs/Dialog.d.ts +2 -2
  45. package/dist/types/src/components/Dialogs/Dialog.d.ts.map +1 -1
  46. package/dist/types/src/components/Dialogs/Dialog.stories.d.ts +2 -2
  47. package/dist/types/src/components/Dialogs/Dialog.stories.d.ts.map +1 -1
  48. package/dist/types/src/components/ElevationProvider/ElevationProvider.d.ts.map +1 -1
  49. package/dist/types/src/components/Input/Input.d.ts +1 -1
  50. package/dist/types/src/components/Input/Input.d.ts.map +1 -1
  51. package/dist/types/src/components/Input/Input.stories.d.ts +33 -159
  52. package/dist/types/src/components/Input/Input.stories.d.ts.map +1 -1
  53. package/dist/types/src/components/Lists/ListDropIndicator.d.ts.map +1 -1
  54. package/dist/types/src/components/Lists/Tree.stories.d.ts.map +1 -1
  55. package/dist/types/src/components/Lists/TreeDropIndicator.d.ts.map +1 -1
  56. package/dist/types/src/components/Lists/Treegrid.stories.d.ts +1 -1
  57. package/dist/types/src/components/Lists/Treegrid.stories.d.ts.map +1 -1
  58. package/dist/types/src/components/Main/Main.d.ts.map +1 -1
  59. package/dist/types/src/components/Main/Main.stories.d.ts.map +1 -1
  60. package/dist/types/src/components/Main/useSwipeToDismiss.d.ts.map +1 -1
  61. package/dist/types/src/components/Message/Message.stories.d.ts +8 -2
  62. package/dist/types/src/components/Message/Message.stories.d.ts.map +1 -1
  63. package/dist/types/src/components/Popover/Popover.d.ts +15 -6
  64. package/dist/types/src/components/Popover/Popover.d.ts.map +1 -1
  65. package/dist/types/src/components/Popover/Popover.stories.d.ts +5 -1
  66. package/dist/types/src/components/Popover/Popover.stories.d.ts.map +1 -1
  67. package/dist/types/src/components/ScrollArea/ScrollArea.d.ts.map +1 -1
  68. package/dist/types/src/components/ScrollArea/ScrollArea.stories.d.ts.map +1 -1
  69. package/dist/types/src/components/Status/Status.stories.d.ts.map +1 -1
  70. package/dist/types/src/components/ThemeProvider/ThemeProvider.d.ts.map +1 -1
  71. package/dist/types/src/components/ThemeProvider/TranslationsProvider.d.ts +1 -1
  72. package/dist/types/src/components/ThemeProvider/TranslationsProvider.d.ts.map +1 -1
  73. package/dist/types/src/components/Toast/Toast.stories.d.ts +2 -2
  74. package/dist/types/src/components/Toast/Toast.stories.d.ts.map +1 -1
  75. package/dist/types/src/components/Toolbar/Toolbar.stories.d.ts.map +1 -1
  76. package/dist/types/src/components/Tooltip/Tooltip.d.ts +92 -20
  77. package/dist/types/src/components/Tooltip/Tooltip.d.ts.map +1 -1
  78. package/dist/types/src/components/Tooltip/Tooltip.stories.d.ts +40 -17
  79. package/dist/types/src/components/Tooltip/Tooltip.stories.d.ts.map +1 -1
  80. package/dist/types/src/components/index.d.ts +1 -1
  81. package/dist/types/src/components/index.d.ts.map +1 -1
  82. package/dist/types/src/hooks/useDensityContext.d.ts.map +1 -1
  83. package/dist/types/src/hooks/useElevationContext.d.ts.map +1 -1
  84. package/dist/types/src/hooks/useIconHref.d.ts.map +1 -1
  85. package/dist/types/src/hooks/useSafeCollisionPadding.d.ts.map +1 -1
  86. package/dist/types/src/hooks/useVisualViewport.d.ts.map +1 -1
  87. package/dist/types/src/playground/Controls.stories.d.ts +1 -1
  88. package/dist/types/src/playground/Controls.stories.d.ts.map +1 -1
  89. package/dist/types/src/playground/Custom.stories.d.ts +8 -0
  90. package/dist/types/src/playground/Custom.stories.d.ts.map +1 -0
  91. package/dist/types/src/testing/decorators/index.d.ts +1 -1
  92. package/dist/types/src/testing/decorators/index.d.ts.map +1 -1
  93. package/dist/types/src/testing/decorators/{withVariants.d.ts → withSurfaceVariantsLayout.d.ts} +2 -3
  94. package/dist/types/src/testing/decorators/withSurfaceVariantsLayout.d.ts.map +1 -0
  95. package/dist/types/tsconfig.tsbuildinfo +1 -1
  96. package/package.json +25 -15
  97. package/src/components/Avatars/Avatar.stories.tsx +27 -27
  98. package/src/components/Avatars/Avatar.tsx +24 -21
  99. package/src/components/Avatars/AvatarGroup.stories.tsx +4 -5
  100. package/src/components/Breadcrumb/Breadcrumb.stories.tsx +2 -2
  101. package/src/components/Buttons/Button.stories.tsx +20 -15
  102. package/src/components/Buttons/IconButton.stories.tsx +9 -10
  103. package/src/components/Buttons/IconButton.tsx +9 -38
  104. package/src/components/Buttons/Toggle.stories.tsx +2 -2
  105. package/src/components/Buttons/ToggleGroup.stories.tsx +3 -7
  106. package/src/components/Clipboard/CopyButton.tsx +22 -24
  107. package/src/components/Dialogs/AlertDialog.stories.tsx +4 -11
  108. package/src/components/Dialogs/Dialog.stories.tsx +3 -3
  109. package/src/components/Dialogs/Dialog.tsx +8 -4
  110. package/src/components/Input/Input.stories.tsx +69 -58
  111. package/src/components/Input/Input.tsx +1 -0
  112. package/src/components/Lists/Tree.stories.tsx +2 -2
  113. package/src/components/Lists/Treegrid.stories.tsx +12 -12
  114. package/src/components/Main/Main.stories.tsx +2 -2
  115. package/src/components/Main/Main.tsx +1 -0
  116. package/src/components/Menus/ContextMenu.stories.tsx +2 -2
  117. package/src/components/Menus/DropdownMenu.stories.tsx +2 -2
  118. package/src/components/Message/Message.stories.tsx +10 -4
  119. package/src/components/Popover/Popover.stories.tsx +2 -2
  120. package/src/components/Popover/Popover.tsx +8 -4
  121. package/src/components/ScrollArea/ScrollArea.stories.tsx +4 -4
  122. package/src/components/ScrollArea/ScrollArea.tsx +3 -0
  123. package/src/components/Select/Select.stories.tsx +2 -2
  124. package/src/components/Toast/Toast.stories.tsx +15 -10
  125. package/src/components/Toolbar/Toolbar.stories.tsx +2 -2
  126. package/src/components/Tooltip/Tooltip.stories.tsx +43 -18
  127. package/src/components/Tooltip/Tooltip.tsx +733 -58
  128. package/src/components/index.ts +1 -1
  129. package/src/playground/Controls.stories.tsx +4 -4
  130. package/src/playground/Custom.stories.tsx +137 -0
  131. package/src/playground/Typography.stories.tsx +2 -2
  132. package/src/testing/decorators/index.ts +1 -1
  133. package/src/testing/decorators/withSurfaceVariantsLayout.tsx +53 -0
  134. package/dist/types/src/testing/decorators/withVariants.d.ts.map +0 -1
  135. package/src/testing/decorators/withVariants.tsx +0 -45
@@ -1,89 +1,764 @@
1
1
  //
2
- // Copyright 2023 DXOS.org
2
+ // Copyright 2025 DXOS.org
3
3
  //
4
4
 
5
- import {
6
- Provider as TooltipProviderPrimitive,
7
- type TooltipProviderProps as TooltipProviderPrimitiveProps,
8
- Root as TooltipRootPrimitive,
9
- type TooltipProps as TooltipRootPrimitiveProps,
10
- type TooltipContentProps as TooltipContentPrimitiveProps,
11
- TooltipContent as TooltipContentPrimitive,
12
- type TooltipTriggerProps as TooltipTriggerPrimitiveProps,
13
- TooltipTrigger as TooltipTriggerPrimitive,
14
- type TooltipPortalProps as TooltipPortalPrimitiveProps,
15
- TooltipPortal as TooltipPortalPrimitive,
16
- type TooltipArrowProps as TooltipArrowPrimitiveProps,
17
- TooltipArrow as TooltipArrowPrimitive,
18
- } from '@radix-ui/react-tooltip';
19
- import React, { forwardRef, type FunctionComponent } from 'react';
5
+ // This is based upon `@radix-ui/react-tooltip` fetched 17 March 2025 at https://github.com/radix-ui/primitives at commit 6e75e11.
6
+
7
+ import { composeEventHandlers } from '@radix-ui/primitive';
8
+ import { useComposedRefs } from '@radix-ui/react-compose-refs';
9
+ import { createContextScope } from '@radix-ui/react-context';
10
+ import type { Scope } from '@radix-ui/react-context';
11
+ import { DismissableLayer } from '@radix-ui/react-dismissable-layer';
12
+ import { useId } from '@radix-ui/react-id';
13
+ import * as PopperPrimitive from '@radix-ui/react-popper';
14
+ import { createPopperScope, type PopperAnchorProps } from '@radix-ui/react-popper';
15
+ import { Portal as PortalPrimitive } from '@radix-ui/react-portal';
16
+ import { Presence } from '@radix-ui/react-presence';
17
+ import { Primitive } from '@radix-ui/react-primitive';
18
+ import { Slottable } from '@radix-ui/react-slot';
19
+ import { type TooltipProps } from '@radix-ui/react-tooltip';
20
+ import { useControllableState } from '@radix-ui/react-use-controllable-state';
21
+ import * as VisuallyHiddenPrimitive from '@radix-ui/react-visually-hidden';
22
+ import React, {
23
+ type ComponentPropsWithoutRef,
24
+ type ElementRef,
25
+ type FC,
26
+ type SyntheticEvent,
27
+ forwardRef,
28
+ type MutableRefObject,
29
+ type ReactNode,
30
+ useCallback,
31
+ useEffect,
32
+ useMemo,
33
+ useRef,
34
+ useState,
35
+ } from 'react';
20
36
 
21
37
  import { useElevationContext, useThemeContext } from '../../hooks';
22
- import { useSafeCollisionPadding } from '../../hooks/useSafeCollisionPadding';
23
- import { type ThemedClassName } from '../../util';
24
38
 
25
- type TooltipProviderProps = TooltipProviderPrimitiveProps;
39
+ type TooltipScopedProps<P = {}> = P & { __scopeTooltip?: Scope };
40
+ const [createTooltipContext, createTooltipScope] = createContextScope('Tooltip', [createPopperScope]);
41
+ const usePopperScope = createPopperScope();
42
+
43
+ /* -------------------------------------------------------------------------------------------------
44
+ * Tooltip
45
+ * ----------------------------------------------------------------------------------------------- */
26
46
 
27
- const TooltipProvider: FunctionComponent<TooltipProviderProps> = TooltipProviderPrimitive;
47
+ const DEFAULT_DELAY_DURATION = 700;
48
+ const TOOLTIP_OPEN = 'tooltip.open';
49
+ const TOOLTIP_NAME = 'Tooltip';
50
+
51
+ type TooltipContextValue = {
52
+ contentId: string;
53
+ open: boolean;
54
+ stateAttribute: 'closed' | 'delayed-open' | 'instant-open';
55
+ trigger: TooltipTriggerElement | null;
56
+ onTriggerChange(trigger: TooltipTriggerElement | null): void;
57
+ onTriggerEnter(): void;
58
+ onTriggerLeave(): void;
59
+ onOpen(): void;
60
+ onClose(): void;
61
+ onPointerInTransitChange(inTransit: boolean): void;
62
+ isPointerInTransitRef: MutableRefObject<boolean>;
63
+ disableHoverableContent: boolean;
64
+ };
28
65
 
29
- type TooltipRootProps = TooltipRootPrimitiveProps;
66
+ const [TooltipContextProvider, useTooltipContext] = createTooltipContext<TooltipContextValue>(TOOLTIP_NAME);
30
67
 
31
- const TooltipRoot: FunctionComponent<TooltipRootProps> = TooltipRootPrimitive;
68
+ interface TooltipProviderProps {
69
+ children?: ReactNode;
70
+ open?: boolean;
71
+ defaultOpen?: boolean;
72
+ onOpenChange?: (open: boolean) => void;
73
+ /**
74
+ * The duration from when the pointer enters the trigger until the tooltip gets opened. This will
75
+ * override the prop with the same name passed to Provider.
76
+ * @defaultValue 700
77
+ */
78
+ delayDuration?: number;
79
+ /**
80
+ * When `true`, trying to hover the content will result in the tooltip closing as the pointer leaves the trigger.
81
+ * @defaultValue false
82
+ */
83
+ disableHoverableContent?: boolean;
84
+ /**
85
+ * How much time a user has to enter another trigger without incurring a delay again.
86
+ * @defaultValue 300
87
+ */
88
+ skipDelayDuration?: number;
89
+ }
32
90
 
33
- type TooltipPortalProps = TooltipPortalPrimitiveProps;
91
+ const TooltipProvider: FC<TooltipProviderProps> = (props: TooltipScopedProps<TooltipProviderProps>) => {
92
+ const {
93
+ __scopeTooltip,
94
+ children,
95
+ open: openProp,
96
+ defaultOpen = false,
97
+ onOpenChange,
98
+ disableHoverableContent = false,
99
+ delayDuration = DEFAULT_DELAY_DURATION,
100
+ skipDelayDuration = 300,
101
+ } = props;
102
+ const isOpenDelayedRef = useRef(true);
103
+ const isPointerInTransitRef = useRef(false);
104
+ const skipDelayTimerRef = useRef(0);
105
+
106
+ useEffect(() => {
107
+ const skipDelayTimer = skipDelayTimerRef.current;
108
+ return () => window.clearTimeout(skipDelayTimer);
109
+ }, []);
110
+
111
+ const popperScope = usePopperScope(__scopeTooltip);
112
+ const [trigger, setTrigger] = useState<HTMLButtonElement | null>(null);
113
+ const [content, setContent] = useState<string>('');
114
+ const [side, setSide] = useState<TooltipSide | undefined>(undefined);
115
+ const triggerRef = useRef<HTMLButtonElement | null>(trigger);
116
+ const handleTriggerChange = useCallback((nextTrigger: HTMLButtonElement | null) => {
117
+ setTrigger(nextTrigger);
118
+ triggerRef.current = nextTrigger;
119
+ setContent(nextTrigger?.getAttribute('data-tooltip-content') ?? '');
120
+ setSide((nextTrigger?.getAttribute('data-tooltip-side') as TooltipSide | null) ?? undefined);
121
+ }, []);
122
+ const contentId = useId();
123
+ const openTimerRef = useRef(0);
124
+ const wasOpenDelayedRef = useRef(false);
125
+ const handleOpenChange = useCallback(
126
+ (open: boolean) => {
127
+ if (open) {
128
+ window.clearTimeout(skipDelayTimerRef.current);
129
+ isOpenDelayedRef.current = false;
130
+ // as `onChange` is called within a lifecycle method we
131
+ // avoid dispatching via `dispatchDiscreteCustomEvent`.
132
+ document.dispatchEvent(new CustomEvent(TOOLTIP_OPEN));
133
+ } else {
134
+ window.clearTimeout(skipDelayTimerRef.current);
135
+ skipDelayTimerRef.current = window.setTimeout(() => (isOpenDelayedRef.current = true), skipDelayDuration);
136
+ }
137
+ onOpenChange?.(open);
138
+ },
139
+ [skipDelayDuration, onOpenChange],
140
+ );
141
+ const [open = false, setOpen] = useControllableState({
142
+ prop: openProp,
143
+ defaultProp: defaultOpen,
144
+ onChange: handleOpenChange,
145
+ });
146
+ const stateAttribute = useMemo(() => {
147
+ return open ? (wasOpenDelayedRef.current ? 'delayed-open' : 'instant-open') : 'closed';
148
+ }, [open]);
34
149
 
35
- const TooltipPortal = TooltipPortalPrimitive;
150
+ const handleOpen = useCallback(() => {
151
+ window.clearTimeout(openTimerRef.current);
152
+ openTimerRef.current = 0;
153
+ wasOpenDelayedRef.current = false;
154
+ setOpen(true);
155
+ }, [setOpen]);
36
156
 
37
- type TooltipTriggerProps = TooltipTriggerPrimitiveProps;
157
+ const handleClose = useCallback(() => {
158
+ window.clearTimeout(openTimerRef.current);
159
+ openTimerRef.current = 0;
160
+ setOpen(false);
161
+ }, [setOpen]);
38
162
 
39
- const TooltipTrigger = TooltipTriggerPrimitive;
163
+ const handleDelayedOpen = useCallback(() => {
164
+ window.clearTimeout(openTimerRef.current);
165
+ openTimerRef.current = window.setTimeout(() => {
166
+ wasOpenDelayedRef.current = true;
167
+ setOpen(true);
168
+ openTimerRef.current = 0;
169
+ }, delayDuration);
170
+ }, [delayDuration, setOpen]);
40
171
 
41
- type TooltipArrowProps = ThemedClassName<TooltipArrowPrimitiveProps>;
172
+ useEffect(() => {
173
+ return () => {
174
+ if (openTimerRef.current) {
175
+ window.clearTimeout(openTimerRef.current);
176
+ openTimerRef.current = 0;
177
+ }
178
+ };
179
+ }, []);
42
180
 
43
- const TooltipArrow = forwardRef<SVGSVGElement, TooltipArrowProps>(({ classNames, ...props }, forwardedRef) => {
44
181
  const { tx } = useThemeContext();
182
+ const elevation = useElevationContext();
183
+
45
184
  return (
46
- <TooltipArrowPrimitive
47
- {...props}
48
- className={tx('tooltip.arrow', 'tooltip__arrow', {}, classNames)}
49
- ref={forwardedRef}
50
- />
185
+ <PopperPrimitive.Root {...popperScope}>
186
+ <TooltipContextProvider
187
+ scope={__scopeTooltip}
188
+ contentId={contentId}
189
+ open={open}
190
+ stateAttribute={stateAttribute}
191
+ trigger={trigger}
192
+ onTriggerChange={handleTriggerChange}
193
+ onTriggerEnter={useCallback(() => {
194
+ if (isOpenDelayedRef.current) {
195
+ handleDelayedOpen();
196
+ } else {
197
+ handleOpen();
198
+ }
199
+ }, [isOpenDelayedRef, handleDelayedOpen, handleOpen])}
200
+ onTriggerLeave={useCallback(() => {
201
+ if (disableHoverableContent) {
202
+ handleClose();
203
+ } else {
204
+ // Clear the timer in case the pointer leaves the trigger before the tooltip is opened.
205
+ window.clearTimeout(openTimerRef.current);
206
+ openTimerRef.current = 0;
207
+ }
208
+ }, [handleClose, disableHoverableContent])}
209
+ onOpen={handleOpen}
210
+ onClose={handleClose}
211
+ disableHoverableContent={disableHoverableContent}
212
+ isPointerInTransitRef={isPointerInTransitRef}
213
+ onPointerInTransitChange={useCallback((inTransit: boolean) => {
214
+ isPointerInTransitRef.current = inTransit;
215
+ }, [])}
216
+ >
217
+ <TooltipContent side={side} className={tx('tooltip.content', 'tooltip', { elevation })}>
218
+ {content}
219
+ <TooltipArrow className={tx('tooltip.arrow', 'tooltip__arrow')} />
220
+ </TooltipContent>
221
+ <TooltipVirtualTrigger virtualRef={triggerRef} />
222
+ {children}
223
+ </TooltipContextProvider>
224
+ </PopperPrimitive.Root>
51
225
  );
52
- });
226
+ };
53
227
 
54
- type TooltipContentProps = ThemedClassName<TooltipContentPrimitiveProps>;
228
+ TooltipProvider.displayName = TOOLTIP_NAME;
229
+
230
+ /* -------------------------------------------------------------------------------------------------
231
+ * TooltipVirtualTrigger
232
+ * ----------------------------------------------------------------------------------------------- */
233
+
234
+ const TooltipVirtualTrigger = ({
235
+ virtualRef,
236
+ __scopeTooltip,
237
+ }: TooltipScopedProps<Pick<PopperAnchorProps, 'virtualRef'>>) => {
238
+ const popperScope = usePopperScope(__scopeTooltip);
239
+ return <PopperPrimitive.Anchor asChild {...popperScope} virtualRef={virtualRef} />;
240
+ };
241
+
242
+ /* -------------------------------------------------------------------------------------------------
243
+ * TooltipTrigger
244
+ * ----------------------------------------------------------------------------------------------- */
245
+
246
+ const TRIGGER_NAME = 'TooltipTrigger';
247
+
248
+ type TooltipTriggerElement = ElementRef<typeof Primitive.button>;
249
+ type PrimitiveButtonProps = ComponentPropsWithoutRef<typeof Primitive.button>;
250
+ type TooltipTriggerProps = PrimitiveButtonProps &
251
+ Pick<TooltipProps, 'delayDuration'> & {
252
+ content?: string;
253
+ side?: TooltipSide;
254
+ onInteract?: (event: SyntheticEvent) => void;
255
+ };
256
+
257
+ const TooltipTrigger = forwardRef<TooltipTriggerElement, TooltipTriggerProps>(
258
+ (props: TooltipScopedProps<TooltipTriggerProps>, forwardedRef) => {
259
+ const {
260
+ __scopeTooltip,
261
+ onInteract,
262
+ // TODO(thure): Pass `delayDuration` into the context.
263
+ delayDuration: _delayDuration,
264
+ side,
265
+ content,
266
+ ...triggerProps
267
+ } = props;
268
+ const context = useTooltipContext(TRIGGER_NAME, __scopeTooltip);
269
+ const ref = useRef<TooltipTriggerElement>(null);
270
+ const composedRefs = useComposedRefs(forwardedRef, ref);
271
+ const isPointerDownRef = useRef(false);
272
+ const hasPointerMoveOpenedRef = useRef(false);
273
+ const handlePointerUp = useCallback(() => (isPointerDownRef.current = false), []);
274
+
275
+ useEffect(() => {
276
+ return () => document.removeEventListener('pointerup', handlePointerUp);
277
+ }, [handlePointerUp]);
55
278
 
56
- const TooltipContent = forwardRef<HTMLDivElement, TooltipContentProps>(
57
- ({ classNames, collisionPadding = 8, ...props }, forwardedRef) => {
58
- const { tx } = useThemeContext();
59
- const elevation = useElevationContext();
60
- const safeCollisionPadding = useSafeCollisionPadding(collisionPadding);
61
279
  return (
62
- <TooltipContentPrimitive
63
- sideOffset={4}
64
- {...props}
65
- collisionPadding={safeCollisionPadding}
66
- className={tx('tooltip.content', 'tooltip', { elevation }, classNames)}
67
- ref={forwardedRef}
280
+ <Primitive.button
281
+ // We purposefully avoid adding `type=button` here because tooltip triggers are also
282
+ // commonly anchors and the anchor `type` attribute signifies MIME type.
283
+ aria-describedby={context.open ? context.contentId : undefined}
284
+ data-state={context.stateAttribute}
285
+ data-tooltip-content={content}
286
+ data-tooltip-side={side}
287
+ {...triggerProps}
288
+ ref={composedRefs}
289
+ onPointerMove={composeEventHandlers(props.onPointerMove, (event) => {
290
+ if (event.pointerType === 'touch') {
291
+ return;
292
+ }
293
+ if (!hasPointerMoveOpenedRef.current && !context.isPointerInTransitRef.current) {
294
+ onInteract?.(event);
295
+ if (event.defaultPrevented) {
296
+ return;
297
+ }
298
+ context.onTriggerChange(ref.current);
299
+ context.onTriggerEnter();
300
+ hasPointerMoveOpenedRef.current = true;
301
+ }
302
+ })}
303
+ onPointerLeave={composeEventHandlers(props.onPointerLeave, () => {
304
+ context.onTriggerLeave();
305
+ hasPointerMoveOpenedRef.current = false;
306
+ })}
307
+ onPointerDown={composeEventHandlers(props.onPointerDown, () => {
308
+ if (context.open) {
309
+ context.onClose();
310
+ }
311
+ isPointerDownRef.current = true;
312
+ document.addEventListener('pointerup', handlePointerUp, { once: true });
313
+ })}
314
+ onFocus={props.onFocus}
315
+ onBlur={composeEventHandlers(props.onBlur, context.onClose)}
316
+ onClick={composeEventHandlers(props.onClick, context.onClose)}
68
317
  />
69
318
  );
70
319
  },
71
320
  );
72
321
 
322
+ TooltipTrigger.displayName = TRIGGER_NAME;
323
+
324
+ /* -------------------------------------------------------------------------------------------------
325
+ * TooltipPortal
326
+ * ----------------------------------------------------------------------------------------------- */
327
+
328
+ const PORTAL_NAME = 'TooltipPortal';
329
+
330
+ type PortalContextValue = { forceMount?: true };
331
+ const [PortalProvider, usePortalContext] = createTooltipContext<PortalContextValue>(PORTAL_NAME, {
332
+ forceMount: undefined,
333
+ });
334
+
335
+ type PortalProps = ComponentPropsWithoutRef<typeof PortalPrimitive>;
336
+ interface TooltipPortalProps {
337
+ children?: ReactNode;
338
+ /**
339
+ * Specify a container element to portal the content into.
340
+ */
341
+ container?: PortalProps['container'];
342
+ /**
343
+ * Used to force mounting when more control is needed. Useful when
344
+ * controlling animation with React animation libraries.
345
+ */
346
+ forceMount?: true;
347
+ }
348
+
349
+ const TooltipPortal: FC<TooltipPortalProps> = (props: TooltipScopedProps<TooltipPortalProps>) => {
350
+ const { __scopeTooltip, forceMount, children, container } = props;
351
+ const context = useTooltipContext(PORTAL_NAME, __scopeTooltip);
352
+ return (
353
+ <PortalProvider scope={__scopeTooltip} forceMount={forceMount}>
354
+ <Presence present={forceMount || context.open}>
355
+ <PortalPrimitive asChild container={container}>
356
+ {children}
357
+ </PortalPrimitive>
358
+ </Presence>
359
+ </PortalProvider>
360
+ );
361
+ };
362
+
363
+ TooltipPortal.displayName = PORTAL_NAME;
364
+
365
+ /* -------------------------------------------------------------------------------------------------
366
+ * TooltipContent
367
+ * ----------------------------------------------------------------------------------------------- */
368
+
369
+ const CONTENT_NAME = 'TooltipContent';
370
+
371
+ type TooltipContentElement = TooltipContentImplElement;
372
+ interface TooltipContentProps extends TooltipContentImplProps {
373
+ /**
374
+ * Used to force mounting when more control is needed. Useful when
375
+ * controlling animation with React animation libraries.
376
+ */
377
+ forceMount?: true;
378
+ }
379
+
380
+ const TooltipContent = forwardRef<TooltipContentElement, TooltipContentProps>(
381
+ (props: TooltipScopedProps<TooltipContentProps>, forwardedRef) => {
382
+ const portalContext = usePortalContext(CONTENT_NAME, props.__scopeTooltip);
383
+ const { forceMount = portalContext.forceMount, side = 'top', ...contentProps } = props;
384
+ const context = useTooltipContext(CONTENT_NAME, props.__scopeTooltip);
385
+
386
+ return (
387
+ <Presence present={forceMount || context.open}>
388
+ {context.disableHoverableContent ? (
389
+ <TooltipContentImpl side={side} {...contentProps} ref={forwardedRef} />
390
+ ) : (
391
+ <TooltipContentHoverable side={side} {...contentProps} ref={forwardedRef} />
392
+ )}
393
+ </Presence>
394
+ );
395
+ },
396
+ );
397
+
398
+ type Point = { x: number; y: number };
399
+ type Polygon = Point[];
400
+
401
+ type TooltipContentHoverableElement = TooltipContentImplElement;
402
+ interface TooltipContentHoverableProps extends TooltipContentImplProps {}
403
+
404
+ const TooltipContentHoverable = forwardRef<TooltipContentHoverableElement, TooltipContentHoverableProps>(
405
+ (props: TooltipScopedProps<TooltipContentHoverableProps>, forwardedRef) => {
406
+ const context = useTooltipContext(CONTENT_NAME, props.__scopeTooltip);
407
+ const ref = useRef<TooltipContentHoverableElement>(null);
408
+ const composedRefs = useComposedRefs(forwardedRef, ref);
409
+ const [pointerGraceArea, setPointerGraceArea] = useState<Polygon | null>(null);
410
+
411
+ const { trigger, onClose } = context;
412
+ const content = ref.current;
413
+
414
+ const { onPointerInTransitChange } = context;
415
+
416
+ const handleRemoveGraceArea = useCallback(() => {
417
+ setPointerGraceArea(null);
418
+ onPointerInTransitChange(false);
419
+ }, [onPointerInTransitChange]);
420
+
421
+ const handleCreateGraceArea = useCallback(
422
+ (event: PointerEvent, hoverTarget: HTMLElement) => {
423
+ const currentTarget = event.currentTarget as HTMLElement;
424
+ const exitPoint = { x: event.clientX, y: event.clientY };
425
+ const exitSide = getExitSideFromRect(exitPoint, currentTarget.getBoundingClientRect());
426
+ const paddedExitPoints = getPaddedExitPoints(exitPoint, exitSide);
427
+ const hoverTargetPoints = getPointsFromRect(hoverTarget.getBoundingClientRect());
428
+ const graceArea = getHull([...paddedExitPoints, ...hoverTargetPoints]);
429
+ setPointerGraceArea(graceArea);
430
+ onPointerInTransitChange(true);
431
+ },
432
+ [onPointerInTransitChange],
433
+ );
434
+
435
+ useEffect(() => {
436
+ return () => handleRemoveGraceArea();
437
+ }, [handleRemoveGraceArea]);
438
+
439
+ useEffect(() => {
440
+ if (trigger && content) {
441
+ const handleTriggerLeave = (event: PointerEvent) => handleCreateGraceArea(event, content);
442
+ const handleContentLeave = (event: PointerEvent) => handleCreateGraceArea(event, trigger);
443
+
444
+ trigger.addEventListener('pointerleave', handleTriggerLeave);
445
+ content.addEventListener('pointerleave', handleContentLeave);
446
+ return () => {
447
+ trigger.removeEventListener('pointerleave', handleTriggerLeave);
448
+ content.removeEventListener('pointerleave', handleContentLeave);
449
+ };
450
+ }
451
+ }, [trigger, content, handleCreateGraceArea, handleRemoveGraceArea]);
452
+
453
+ useEffect(() => {
454
+ if (pointerGraceArea) {
455
+ const handleTrackPointerGrace = (event: PointerEvent) => {
456
+ const target = event.target as HTMLElement;
457
+ const pointerPosition = { x: event.clientX, y: event.clientY };
458
+ const hasEnteredTarget = trigger?.contains(target) || content?.contains(target);
459
+ const isPointerOutsideGraceArea = !isPointInPolygon(pointerPosition, pointerGraceArea);
460
+
461
+ if (hasEnteredTarget) {
462
+ handleRemoveGraceArea();
463
+ } else if (isPointerOutsideGraceArea) {
464
+ handleRemoveGraceArea();
465
+ onClose();
466
+ }
467
+ };
468
+ document.addEventListener('pointermove', handleTrackPointerGrace);
469
+ return () => document.removeEventListener('pointermove', handleTrackPointerGrace);
470
+ }
471
+ }, [trigger, content, pointerGraceArea, onClose, handleRemoveGraceArea]);
472
+
473
+ return <TooltipContentImpl {...props} ref={composedRefs} />;
474
+ },
475
+ );
476
+
477
+ const [VisuallyHiddenContentContextProvider, useVisuallyHiddenContentContext] = createTooltipContext(TOOLTIP_NAME, {
478
+ isInside: false,
479
+ });
480
+
481
+ type TooltipContentImplElement = ElementRef<typeof PopperPrimitive.Content>;
482
+ type DismissableLayerProps = ComponentPropsWithoutRef<typeof DismissableLayer>;
483
+ type PopperContentProps = ComponentPropsWithoutRef<typeof PopperPrimitive.Content>;
484
+ interface TooltipContentImplProps extends Omit<PopperContentProps, 'onPlaced'> {
485
+ /**
486
+ * A more descriptive label for accessibility purpose
487
+ */
488
+ 'aria-label'?: string;
489
+
490
+ /**
491
+ * Event handler called when the escape key is down.
492
+ * Can be prevented.
493
+ */
494
+ onEscapeKeyDown?: DismissableLayerProps['onEscapeKeyDown'];
495
+ /**
496
+ * Event handler called when the a `pointerdown` event happens outside of the `Tooltip`.
497
+ * Can be prevented.
498
+ */
499
+ onPointerDownOutside?: DismissableLayerProps['onPointerDownOutside'];
500
+ }
501
+
502
+ const TooltipContentImpl = forwardRef<TooltipContentImplElement, TooltipContentImplProps>(
503
+ (props: TooltipScopedProps<TooltipContentImplProps>, forwardedRef) => {
504
+ const {
505
+ __scopeTooltip,
506
+ children,
507
+ 'aria-label': ariaLabel,
508
+ onEscapeKeyDown,
509
+ onPointerDownOutside,
510
+ ...contentProps
511
+ } = props;
512
+ const context = useTooltipContext(CONTENT_NAME, __scopeTooltip);
513
+ const popperScope = usePopperScope(__scopeTooltip);
514
+ const { onClose } = context;
515
+
516
+ // Close this tooltip if another one opens
517
+ useEffect(() => {
518
+ document.addEventListener(TOOLTIP_OPEN, onClose);
519
+ return () => document.removeEventListener(TOOLTIP_OPEN, onClose);
520
+ }, [onClose]);
521
+
522
+ // Close the tooltip if the trigger is scrolled
523
+ useEffect(() => {
524
+ if (context.trigger) {
525
+ const handleScroll = (event: Event) => {
526
+ const target = event.target as HTMLElement;
527
+ if (target?.contains(context.trigger)) {
528
+ onClose();
529
+ }
530
+ };
531
+ window.addEventListener('scroll', handleScroll, { capture: true });
532
+ return () => window.removeEventListener('scroll', handleScroll, { capture: true });
533
+ }
534
+ }, [context.trigger, onClose]);
535
+
536
+ return (
537
+ <DismissableLayer
538
+ asChild
539
+ disableOutsidePointerEvents={false}
540
+ onEscapeKeyDown={onEscapeKeyDown}
541
+ onPointerDownOutside={onPointerDownOutside}
542
+ onFocusOutside={(event) => event.preventDefault()}
543
+ onDismiss={onClose}
544
+ >
545
+ <PopperPrimitive.Content
546
+ data-state={context.stateAttribute}
547
+ {...popperScope}
548
+ {...contentProps}
549
+ ref={forwardedRef}
550
+ style={{
551
+ ...contentProps.style,
552
+ // re-namespace exposed content custom properties
553
+ ...{
554
+ '--radix-tooltip-content-transform-origin': 'var(--radix-popper-transform-origin)',
555
+ '--radix-tooltip-content-available-width': 'var(--radix-popper-available-width)',
556
+ '--radix-tooltip-content-available-height': 'var(--radix-popper-available-height)',
557
+ '--radix-tooltip-trigger-width': 'var(--radix-popper-anchor-width)',
558
+ '--radix-tooltip-trigger-height': 'var(--radix-popper-anchor-height)',
559
+ },
560
+ }}
561
+ >
562
+ <Slottable>{children}</Slottable>
563
+ <VisuallyHiddenContentContextProvider scope={__scopeTooltip} isInside={true}>
564
+ <VisuallyHiddenPrimitive.Root id={context.contentId} role='tooltip'>
565
+ {ariaLabel || children}
566
+ </VisuallyHiddenPrimitive.Root>
567
+ </VisuallyHiddenContentContextProvider>
568
+ </PopperPrimitive.Content>
569
+ </DismissableLayer>
570
+ );
571
+ },
572
+ );
573
+
574
+ TooltipContent.displayName = CONTENT_NAME;
575
+
576
+ /* -------------------------------------------------------------------------------------------------
577
+ * TooltipArrow
578
+ * ----------------------------------------------------------------------------------------------- */
579
+
580
+ const ARROW_NAME = 'TooltipArrow';
581
+
582
+ type TooltipArrowElement = ElementRef<typeof PopperPrimitive.Arrow>;
583
+ type PopperArrowProps = ComponentPropsWithoutRef<typeof PopperPrimitive.Arrow>;
584
+ interface TooltipArrowProps extends PopperArrowProps {}
585
+
586
+ const TooltipArrow = forwardRef<TooltipArrowElement, TooltipArrowProps>(
587
+ (props: TooltipScopedProps<TooltipArrowProps>, forwardedRef) => {
588
+ const { __scopeTooltip, ...arrowProps } = props;
589
+ const popperScope = usePopperScope(__scopeTooltip);
590
+ const visuallyHiddenContentContext = useVisuallyHiddenContentContext(ARROW_NAME, __scopeTooltip);
591
+ // if the arrow is inside the `VisuallyHidden`, we don't want to render it all to
592
+ // prevent issues in positioning the arrow due to the duplicate
593
+ return visuallyHiddenContentContext.isInside ? null : (
594
+ <PopperPrimitive.Arrow {...popperScope} {...arrowProps} ref={forwardedRef} />
595
+ );
596
+ },
597
+ );
598
+
599
+ TooltipArrow.displayName = ARROW_NAME;
600
+
601
+ /* ----------------------------------------------------------------------------------------------- */
602
+
603
+ type TooltipSide = NonNullable<TooltipContentProps['side']>;
604
+
605
+ const getExitSideFromRect = (point: Point, rect: DOMRect): TooltipSide => {
606
+ const top = Math.abs(rect.top - point.y);
607
+ const bottom = Math.abs(rect.bottom - point.y);
608
+ const right = Math.abs(rect.right - point.x);
609
+ const left = Math.abs(rect.left - point.x);
610
+
611
+ switch (Math.min(top, bottom, right, left)) {
612
+ case left:
613
+ return 'left';
614
+ case right:
615
+ return 'right';
616
+ case top:
617
+ return 'top';
618
+ case bottom:
619
+ return 'bottom';
620
+ default:
621
+ throw new Error('unreachable');
622
+ }
623
+ };
624
+
625
+ const getPaddedExitPoints = (exitPoint: Point, exitSide: TooltipSide, padding = 5) => {
626
+ const paddedExitPoints: Point[] = [];
627
+ switch (exitSide) {
628
+ case 'top':
629
+ paddedExitPoints.push(
630
+ { x: exitPoint.x - padding, y: exitPoint.y + padding },
631
+ { x: exitPoint.x + padding, y: exitPoint.y + padding },
632
+ );
633
+ break;
634
+ case 'bottom':
635
+ paddedExitPoints.push(
636
+ { x: exitPoint.x - padding, y: exitPoint.y - padding },
637
+ { x: exitPoint.x + padding, y: exitPoint.y - padding },
638
+ );
639
+ break;
640
+ case 'left':
641
+ paddedExitPoints.push(
642
+ { x: exitPoint.x + padding, y: exitPoint.y - padding },
643
+ { x: exitPoint.x + padding, y: exitPoint.y + padding },
644
+ );
645
+ break;
646
+ case 'right':
647
+ paddedExitPoints.push(
648
+ { x: exitPoint.x - padding, y: exitPoint.y - padding },
649
+ { x: exitPoint.x - padding, y: exitPoint.y + padding },
650
+ );
651
+ break;
652
+ }
653
+ return paddedExitPoints;
654
+ };
655
+
656
+ const getPointsFromRect = (rect: DOMRect) => {
657
+ const { top, right, bottom, left } = rect;
658
+ return [
659
+ { x: left, y: top },
660
+ { x: right, y: top },
661
+ { x: right, y: bottom },
662
+ { x: left, y: bottom },
663
+ ];
664
+ };
665
+
666
+ // Determine if a point is inside of a polygon.
667
+ // Based on https://github.com/substack/point-in-polygon
668
+ const isPointInPolygon = (point: Point, polygon: Polygon) => {
669
+ const { x, y } = point;
670
+ let inside = false;
671
+ for (let i = 0, j = polygon.length - 1; i < polygon.length; j = i++) {
672
+ const xi = polygon[i].x;
673
+ const yi = polygon[i].y;
674
+ const xj = polygon[j].x;
675
+ const yj = polygon[j].y;
676
+
677
+ // prettier-ignore
678
+ const intersect = ((yi > y) !== (yj > y)) && (x < (xj - xi) * (y - yi) / (yj - yi) + xi);
679
+ if (intersect) {
680
+ inside = !inside;
681
+ }
682
+ }
683
+
684
+ return inside;
685
+ };
686
+
687
+ // Returns a new array of points representing the convex hull of the given set of points.
688
+ // https://www.nayuki.io/page/convex-hull-algorithm
689
+ const getHull = <P extends Point>(points: Readonly<Array<P>>): Array<P> => {
690
+ const newPoints: Array<P> = points.slice();
691
+ newPoints.sort((a: Point, b: Point) => {
692
+ if (a.x < b.x) {
693
+ return -1;
694
+ } else if (a.x > b.x) {
695
+ return +1;
696
+ } else if (a.y < b.y) {
697
+ return -1;
698
+ } else if (a.y > b.y) {
699
+ return +1;
700
+ } else {
701
+ return 0;
702
+ }
703
+ });
704
+ return getHullPresorted(newPoints);
705
+ };
706
+
707
+ // Returns the convex hull, assuming that each points[i] <= points[i + 1]. Runs in O(n) time.
708
+ const getHullPresorted = <P extends Point>(points: Readonly<Array<P>>): Array<P> => {
709
+ if (points.length <= 1) {
710
+ return points.slice();
711
+ }
712
+
713
+ const upperHull: Array<P> = [];
714
+ for (let i = 0; i < points.length; i++) {
715
+ const p = points[i];
716
+ while (upperHull.length >= 2) {
717
+ const q = upperHull[upperHull.length - 1];
718
+ const r = upperHull[upperHull.length - 2];
719
+ if ((q.x - r.x) * (p.y - r.y) >= (q.y - r.y) * (p.x - r.x)) {
720
+ upperHull.pop();
721
+ } else {
722
+ break;
723
+ }
724
+ }
725
+ upperHull.push(p);
726
+ }
727
+ upperHull.pop();
728
+
729
+ const lowerHull: Array<P> = [];
730
+ for (let i = points.length - 1; i >= 0; i--) {
731
+ const p = points[i];
732
+ while (lowerHull.length >= 2) {
733
+ const q = lowerHull[lowerHull.length - 1];
734
+ const r = lowerHull[lowerHull.length - 2];
735
+ if ((q.x - r.x) * (p.y - r.y) >= (q.y - r.y) * (p.x - r.x)) {
736
+ lowerHull.pop();
737
+ } else {
738
+ break;
739
+ }
740
+ }
741
+ lowerHull.push(p);
742
+ }
743
+ lowerHull.pop();
744
+
745
+ if (
746
+ upperHull.length === 1 &&
747
+ lowerHull.length === 1 &&
748
+ upperHull[0].x === lowerHull[0].x &&
749
+ upperHull[0].y === lowerHull[0].y
750
+ ) {
751
+ return upperHull;
752
+ } else {
753
+ return upperHull.concat(lowerHull);
754
+ }
755
+ };
756
+
73
757
  export const Tooltip = {
74
758
  Provider: TooltipProvider,
75
- Root: TooltipRoot,
76
- Portal: TooltipPortal,
77
759
  Trigger: TooltipTrigger,
78
- Arrow: TooltipArrow,
79
- Content: TooltipContent,
80
760
  };
81
761
 
82
- export type {
83
- TooltipProviderProps,
84
- TooltipRootProps,
85
- TooltipPortalProps,
86
- TooltipTriggerProps,
87
- TooltipArrowProps,
88
- TooltipContentProps,
89
- };
762
+ export { createTooltipScope, useTooltipContext };
763
+
764
+ export type { TooltipProviderProps, TooltipTriggerProps, TooltipScopedProps, TooltipSide };