ComponentsOverlays
Tooltip
A short hint in ink that shows on hover and focus, with an optional arrow and key hint.
Placements
"use client";
import { Button } from "@/components/miyuki-ui/button";
import { Tooltip, TooltipTrigger } from "@/components/miyuki-ui/tooltip";
const placements = [
{ placement: "top", label: "Top", hint: "Shows above", cell: "col-start-2 row-start-1" },
{ placement: "left", label: "Left", hint: "Shows to the left", cell: "col-start-1 row-start-2" },
{ placement: "right", label: "Right", hint: "Shows to the right", cell: "col-start-3 row-start-2" },
{ placement: "bottom", label: "Bottom", hint: "Shows below", cell: "col-start-2 row-start-3" },
] as const;
export default function TooltipDemo() {
return (
<div className="grid grid-cols-3 grid-rows-3 gap-2">
{placements.map(({ placement, label, hint, cell }) => (
<TooltipTrigger key={placement}>
<Button variant="secondary" className={`w-24 ${cell}`}>
{label}
</Button>
<Tooltip placement={placement} arrow>
{hint}
</Tooltip>
</TooltipTrigger>
))}
</div>
);
}With shortcut
"use client";
import { Plus, Search, Settings } from "lucide-react";
import { IconButton } from "@/components/miyuki-ui/icon-button";
import { Tooltip, TooltipTrigger } from "@/components/miyuki-ui/tooltip";
export default function TooltipShortcutDemo() {
return (
<div className="flex items-center gap-1 rounded-xl border border-border bg-card p-1 shadow-xs">
<TooltipTrigger>
<IconButton variant="ghost" aria-label="Search">
<Search />
</IconButton>
<Tooltip shortcut="⌘K">Search</Tooltip>
</TooltipTrigger>
<TooltipTrigger>
<IconButton variant="ghost" aria-label="New route">
<Plus />
</IconButton>
<Tooltip shortcut="N">New route</Tooltip>
</TooltipTrigger>
<TooltipTrigger>
<IconButton variant="ghost" aria-label="Settings">
<Settings />
</IconButton>
<Tooltip shortcut="⌘,">Settings</Tooltip>
</TooltipTrigger>
</div>
);
}Install
npx shadcn@latest add @miyuki-ui/tooltipThis needs the @miyuki-ui registry in your components.json. See Using the shadcn CLI.
Props
TooltipTrigger
Prop
Type
Tooltip
Prop
Type