@cf/ui

@cf/tooltip

Tooltip

A short text label that appears on hover or focus, mainly to name icon-only buttons and show their shortcut.

Base UI's Tooltip. The provider defaults delay to 0, the popup is the foreground colour with background text, and it makes room for a Kbd inside it.

I treat tooltips as a pointer affordance: a touch device never sees one, so nothing important should live only in a tooltip, and I don't add a touch equivalent. The chat header and notes sidebar use them to label icon buttons that already carry an aria-label.

import { Tooltip, TooltipContent, TooltipTrigger } from "@/components/ui/tooltip";
 
<Tooltip>
  <TooltipTrigger
    render={<Button aria-label="Clear chat" size="icon-sm" variant="ghost" />}
  >
    <TrashIcon data-icon />
  </TooltipTrigger>
  <TooltipContent>Clear chat</TooltipContent>
</Tooltip>

Props

PropTypeDefault
TooltipProvider delaynumber0
TooltipContent sidetop | right | bottom | left | inline-start | inline-endtop
TooltipContent alignstart | center | endcenter
TooltipContent sideOffsetnumber4

Rules

The same rules ship in DESIGN.md and the MCP server, for the agents building with this.

  • must

    Never put links, buttons or anything focusable inside TooltipContent; use a popover or menu for that.

    A tooltip closes as soon as the pointer or focus leaves the trigger, so its content can't be reached.

    no-interactive-content

  • must

    Keep an aria-label on an icon-only trigger even when a Tooltip shows the same words.

    Touch devices never show the tooltip, so it can't be the control's only name.

    not-the-only-name

  • should

    Pass the actual button to TooltipTrigger through render rather than nesting a button inside it.

    render-the-trigger

  • should

    Wrap each area of tooltips in one TooltipProvider, so moving between triggers doesn't wait out the delay each time.

    wrap-in-provider

Install

bunx shadcn@latest add @cf/tooltip

Needs the @cf registry in your components.json once. The theme and any sibling components come along automatically.

Source

tooltip.tsxShow
"use client";
 
import { Tooltip as TooltipPrimitive } from "@base-ui/react/tooltip";
 
import { cn } from "cn";
 
function TooltipProvider({
  delay = 0,
  ...props
}: TooltipPrimitive.Provider.Props) {
  return (
    <TooltipPrimitive.Provider
      data-slot="tooltip-provider"
      delay={delay}
      {...props}
    />
  );
}
 
function Tooltip({ ...props }: TooltipPrimitive.Root.Props) {
  return <TooltipPrimitive.Root data-slot="tooltip" {...props} />;
}
 
function TooltipTrigger({ ...props }: TooltipPrimitive.Trigger.Props) {
  return <TooltipPrimitive.Trigger data-slot="tooltip-trigger" {...props} />;
}
 
function TooltipContent({
  className,
  side = "top",
  sideOffset = 4,
  align = "center",
  alignOffset = 0,
  children,
  ...props
}: TooltipPrimitive.Popup.Props &
  Pick<
    TooltipPrimitive.Positioner.Props,
    "align" | "alignOffset" | "side" | "sideOffset"
  >) {
  return (
    <TooltipPrimitive.Portal>
      <TooltipPrimitive.Positioner
        align={align}
        alignOffset={alignOffset}
        className="isolate z-50"
        side={side}
        sideOffset={sideOffset}
      >
        <TooltipPrimitive.Popup
          className={cn(
            "data-[side=bottom]:slide-in-from-top-2 data-[side=inline-end]:slide-in-from-left-2 data-[side=inline-start]:slide-in-from-right-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-[state=delayed-open]:fade-in-0 data-[state=delayed-open]:zoom-in-95 data-open:fade-in-0 data-open:zoom-in-95 data-closed:fade-out-0 data-closed:zoom-out-95 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-background text-xs has-data-[slot=kbd]:pr-1.5 data-[state=delayed-open]:animate-in data-closed:animate-out data-open:animate-in **:data-[slot=kbd]:relative **:data-[slot=kbd]:isolate **:data-[slot=kbd]:z-50 **:data-[slot=kbd]:rounded-sm",
            className
          )}
          data-slot="tooltip-content"
          {...props}
        >
          {children}
          <TooltipPrimitive.Arrow className="z-50 size-2.5 translate-y-[calc(-50%-2px)] rotate-45 rounded-[2px] bg-foreground fill-foreground data-[side=bottom]:top-1 data-[side=inline-end]:top-1/2! data-[side=inline-start]:top-1/2! data-[side=left]:top-1/2! data-[side=right]:top-1/2! data-[side=inline-start]:-right-1 data-[side=left]:-right-1 data-[side=top]:-bottom-2.5 data-[side=inline-end]:-left-1 data-[side=right]:-left-1 data-[side=inline-end]:-translate-y-1/2 data-[side=inline-start]:-translate-y-1/2 data-[side=left]:-translate-y-1/2 data-[side=right]:-translate-y-1/2" />
        </TooltipPrimitive.Popup>
      </TooltipPrimitive.Positioner>
    </TooltipPrimitive.Portal>
  );
}
 
export { Tooltip, TooltipContent, TooltipProvider, TooltipTrigger };