Skip to main content

Tooltip

Example

import {
Button,
Tooltip,
TooltipContent,
TooltipProvider,
TooltipTrigger,
} from "@databricks/appkit-ui/react"

export default function TooltipExample() {
return (
<TooltipProvider>
<Tooltip>
<TooltipTrigger asChild>
<Button variant="outline">Hover</Button>
</TooltipTrigger>
<TooltipContent>
<p>Add to library</p>
</TooltipContent>
</Tooltip>
</TooltipProvider>
)
}

Tooltip

Source: packages/appkit-ui/src/react/ui/tooltip.tsx

Props

PropTypeRequiredDefaultDescription
openboolean--
defaultOpenboolean--
onOpenChange((open: boolean) => void)--
delayDurationnumber-The duration from when the pointer enters the trigger until the tooltip gets opened. This will override the prop with the same name passed to Provider. @defaultValue 700
disableHoverableContentboolean-When true, trying to hover the content will result in the tooltip closing as the pointer leaves the trigger. @defaultValue false

Usage

import { Tooltip } from '@databricks/appkit-ui';

<Tooltip /* props */ />

TooltipContent

Source: packages/appkit-ui/src/react/ui/tooltip.tsx

Props

PropTypeRequiredDefaultDescription
forceMounttrue-Used to force mounting when more control is needed. Useful when controlling animation with React animation libraries.
aria-labelstring-A more descriptive label for accessibility purpose
onEscapeKeyDown((event: KeyboardEvent) => void)-Event handler called when the escape key is down. Can be prevented.
onPointerDownOutside((event: PointerDownOutsideEvent) => void)-Event handler called when the a pointerdown event happens outside of the Tooltip. Can be prevented.
asChildboolean--
alignenum--
sideenum--
sideOffsetnumber--
alignOffsetnumber--
arrowPaddingnumber--
avoidCollisionsboolean--
collisionBoundaryBoundary | Boundary[]--
collisionPaddingnumber | Partial<Record<"left" | "right" | "top" | "bottom", number>>--
stickyenum--
hideWhenDetachedboolean--
updatePositionStrategyenum--

Usage

import { TooltipContent } from '@databricks/appkit-ui';

<TooltipContent /* props */ />

TooltipProvider

Source: packages/appkit-ui/src/react/ui/tooltip.tsx

Props

PropTypeRequiredDefaultDescription
delayDurationnumber-The duration from when the pointer enters the trigger until the tooltip gets opened. This will override the prop with the same name passed to Provider. @defaultValue 700
skipDelayDurationnumber-How much time a user has to enter another trigger without incurring a delay again. @defaultValue 300
disableHoverableContentboolean-When true, trying to hover the content will result in the tooltip closing as the pointer leaves the trigger. @defaultValue false

Usage

import { TooltipProvider } from '@databricks/appkit-ui';

<TooltipProvider /* props */ />

TooltipTrigger

Source: packages/appkit-ui/src/react/ui/tooltip.tsx

Props

PropTypeRequiredDefaultDescription
asChildboolean--

Usage

import { TooltipTrigger } from '@databricks/appkit-ui';

<TooltipTrigger /* props */ />