Tooltip

Tooltip wraps Radix primitives with Brandit styles and ships a composed API: TooltipProvider, Tooltip, TooltipTrigger, and TooltipContent.

When to use

  • Explain the purpose of an icon-only or compact control.
  • Provide non-critical hints without interrupting user flow.
  • Show lightweight contextual metadata on hover/focus.

Behavior notes

  • Use TooltipProvider once near the section/app root for consistent delay settings.
  • Use TooltipTrigger with asChild to wrap existing interactive elements.
  • TooltipContent renders in a portal and includes a styled arrow.

Example

<TooltipProvider>
  <Tooltip>
    <TooltipTrigger asChild>
      <Button variant='outline' size='sm'>
        Hover me
      </Button>
    </TooltipTrigger>
    <TooltipContent side='top'>Copy command</TooltipContent>
  </Tooltip>
</TooltipProvider>

Preview

Usage

import { Button } from '@branditdev/ui';

import {
  Tooltip,
  TooltipContent,
  TooltipProvider,
  TooltipTrigger,
} from './tooltip';

export function TooltipDemo() {
  return (
    <TooltipProvider>
      <div className='flex flex-wrap items-center gap-3'>
        <Tooltip>
          <TooltipTrigger asChild>
            <Button variant='outline' size='sm'>
              Hover me
            </Button>
          </TooltipTrigger>
          <TooltipContent>Tooltip content</TooltipContent>
        </Tooltip>
      </div>
    </TooltipProvider>
  );
}

API

Tooltip(__namedParameters): Element

Defined in: components/tooltip/tooltip.tsx:45

Root tooltip container for trigger/content composition.

Parameters

NameTypeOptionalDefaultDescription
__namedParametersTooltipPropsno--

Returns

Element

Source

'use client';

import { Tooltip as TooltipPrimitive } from 'radix-ui';
import * as React from 'react';

import { cn } from '@branditdev/ui';

export type TooltipProviderProps = React.ComponentProps<
  typeof TooltipPrimitive.Provider
>;

export type TooltipProps = React.ComponentProps<typeof TooltipPrimitive.Root>;

export type TooltipTriggerProps = React.ComponentProps<
  typeof TooltipPrimitive.Trigger
>;

export type TooltipContentProps = React.ComponentProps<
  typeof TooltipPrimitive.Content
>;

function TooltipProvider({
  delayDuration = 0,
  ...props
}: TooltipProviderProps) {
  return (
    <TooltipPrimitive.Provider
      data-slot='tooltip-provider'
      delayDuration={delayDuration}
      {...props}
    />
  );
}

function Tooltip({ ...props }: TooltipProps) {
  return <TooltipPrimitive.Root data-slot='tooltip' {...props} />;
}

function TooltipTrigger({ ...props }: TooltipTriggerProps) {
  return <TooltipPrimitive.Trigger data-slot='tooltip-trigger' {...props} />;
}

function TooltipContent({
  className,
  sideOffset = 8,
  children,
  ...props
}: TooltipContentProps) {
  return (
    <TooltipPrimitive.Portal>
      <TooltipPrimitive.Content
        data-slot='tooltip-content'
        sideOffset={sideOffset}
        className={cn(
          'bg-foreground text-background animate-in fade-in-0 zoom-in-95 data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=closed]:zoom-out-95 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 z-50 w-fit origin-(--radix-tooltip-content-transform-origin) rounded-md px-3 py-1.5 text-xs text-balance',
          className
        )}
        {...props}
      >
        {children}
        <TooltipPrimitive.Arrow className='bg-foreground fill-foreground z-50 size-2.5 translate-y-[calc(-50%-2px)] rotate-45 rounded-[2px]' />
      </TooltipPrimitive.Content>
    </TooltipPrimitive.Portal>
  );
}

export { Tooltip, TooltipTrigger, TooltipContent, TooltipProvider };
TableTypography