Open History to see the last commit
1import { Tooltip as TooltipPrimitive } from '@ark-ui/solid'
2import { createContext, splitProps, useContext } from 'solid-js'
3import type { Accessor, JSX } from 'solid-js'
4import { Portal } from '@/components/ui/portal'
5import { cn } from '@/utils'
6β
7// Ported from the original shadcn/ui + Radix UI + React component.
8// This wraps the Ark UI + SolidJS primitive and preserves shadcn's Tailwind-based
9// design-system API, variants, and styling.
10// https://ui.shadcn.com/
11β
12type TooltipProviderProps = {
13 children?: JSX.Element
14} & Pick<
15 TooltipPrimitive.RootProps,
16 'interactive' | 'openDelay' | 'positioning'
17>
18β
19type TooltipPositioning = NonNullable<TooltipPrimitive.RootProps['positioning']>
20β
21type TooltipProviderContextValue = {
22 interactive: Accessor<TooltipPrimitive.RootProps['interactive']>
23 openDelay: Accessor<TooltipPrimitive.RootProps['openDelay']>
24 positioning: Accessor<TooltipPrimitive.RootProps['positioning']>
25}
26β
27const TooltipProviderContext = createContext<TooltipProviderContextValue>()
28β
29/**
30 * Provides default timing, positioning, and interaction behavior for nested
31 * tooltips.
32 *
33 * @example
34 * ```tsx
35 * <TooltipProvider>
36 * <Tooltip>
37 * <TooltipTrigger>Hover me</TooltipTrigger>
38 * <TooltipContent>Helpful context</TooltipContent>
39 * </Tooltip>
40 * </TooltipProvider>
41 * ```
42 */
43function TooltipProvider(props: TooltipProviderProps) {
44 const [local] = splitProps(props, [
45 'children',
46 'interactive',
47 'openDelay',
48 'positioning',
49 ])
50β
51 const value: TooltipProviderContextValue = {
52 interactive: () => local.interactive,
53 openDelay: () => local.openDelay,
54 positioning: () => local.positioning,
55 }
56β
57 return (
58 <TooltipProviderContext.Provider value={value}>
59 {local.children}
60 </TooltipProviderContext.Provider>
61 )
62}
63β
64/**
65 * The root component that coordinates tooltip trigger and content state.
66 *
67 * @example
68 * ```tsx
69 * <TooltipProvider>
70 * <Tooltip>
71 * <TooltipTrigger>Hover me</TooltipTrigger>
72 * <TooltipContent>Helpful context</TooltipContent>
73 * </Tooltip>
74 * </TooltipProvider>
75 * ```
76 */
77function Tooltip(props: TooltipPrimitive.RootProps) {
78 const [local, others] = splitProps(props, [
79 'children',
80 'interactive',
81 'openDelay',
82 'positioning',
83 ])
84 const provider = useContext(TooltipProviderContext)
85β
86 const positioning = (): TooltipPositioning =>
87 Object.assign({ gutter: 0 }, provider?.positioning(), local.positioning)
88β
89 return (
90 <TooltipPrimitive.Root
91 openDelay={local.openDelay ?? provider?.openDelay() ?? 0}
92 interactive={local.interactive ?? provider?.interactive() ?? true}
93 positioning={positioning()}
94 {...others}
95 >
96 {local.children}
97 </TooltipPrimitive.Root>
98 )
99}
100β
101/**
102 * The element that opens its associated TooltipContent on hover or focus.
103 *
104 * @example
105 * ```tsx
106 * <TooltipProvider>
107 * <Tooltip>
108 * <TooltipTrigger>Hover me</TooltipTrigger>
109 * <TooltipContent>Helpful context</TooltipContent>
110 * </Tooltip>
111 * </TooltipProvider>
112 * ```
113 */
114function TooltipTrigger(props: TooltipPrimitive.TriggerProps) {
115 const [local, others] = splitProps(props, ['class'])
116β
117 return (
118 <TooltipPrimitive.Trigger
119 data-slot="tooltip-trigger"
120 class={local.class}
121 {...others}
122 />
123 )
124}
125β
126/**
127 * The floating tooltip surface shown for the associated TooltipTrigger.
128 *
129 * @example
130 * ```tsx
131 * <TooltipProvider>
132 * <Tooltip>
133 * <TooltipTrigger>Hover me</TooltipTrigger>
134 * <TooltipContent>Helpful context</TooltipContent>
135 * </Tooltip>
136 * </TooltipProvider>
137 * ```
138 */
139function TooltipContent(props: TooltipPrimitive.ContentProps) {
140 const [local, others] = splitProps(props, ['children', 'class'])
141β
142 return (
143 <Portal>
144 <TooltipPrimitive.Positioner data-slot="tooltip-positioner">
145 <TooltipPrimitive.Content
146 data-slot="tooltip-content"
147 class={cn(
148 'z-50 inline-flex w-fit max-w-xs origin-(--transform-origin) items-center gap-1.5 rounded-md bg-foreground px-3 py-1.5 text-xs text-background has-data-[slot=kbd]:pr-1.5 data-[side=bottom]:slide-in-from-top-2 data-[side=left]:slide-in-from-right-2 data-[side=right]:slide-in-from-left-2 data-[side=top]:slide-in-from-bottom-2 **:data-[slot=kbd]:relative **:data-[slot=kbd]:isolate **:data-[slot=kbd]:z-50 **:data-[slot=kbd]:rounded-sm data-open:animate-in data-open:fade-in-0 data-open:zoom-in-95 data-closed:animate-out data-closed:fade-out-0 data-closed:zoom-out-95',
149 local.class,
150 )}
151 {...others}
152 >
153 {local.children}
154 <TooltipPrimitive.Arrow
155 data-slot="tooltip-arrow"
156 class="z-50 [--arrow-background:var(--foreground)] [--arrow-size:--spacing(2.5)]"
157 >
158 <TooltipPrimitive.ArrowTip
159 data-slot="tooltip-arrow-tip"
160 class="rounded-xs"
161 />
162 </TooltipPrimitive.Arrow>
163 </TooltipPrimitive.Content>
164 </TooltipPrimitive.Positioner>
165 </Portal>
166 )
167}
168β
169export { Tooltip, TooltipContent, TooltipProvider, TooltipTrigger }