@dxos/react-ui 0.8.2-main.fbd8ed0 → 0.8.2-staging.7ac8446

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