コンテンツへスキップ
1.6k

ツールチップ

アイコンボタン、キーボードショートカット、および省略されたラベルに対するホバー時およびフォーカス時のヒント表示――ネオブルータリズム風の枠線と影の演出を施しています。

import { Button } from "@/components/ui/button"
import {
  Tooltip,

Tooltip は、ホバーまたはキーボードフォーカスで現れ、包むコントロールを説明する短いラベルです。補足テキストであり、インタラクティブな内容の置き場ではありません。Base UI Tooltip プリミティブ上に構築され、ポータルと衝突回避に対応し、ネオブルータリストのレシピに沿ってスタイルしています。太い枠線、硬い影、どの背景でも読める反転した塗りです。

次のような場面で使います：

  • アイコンのみのボタン — 裸のアイコンでは伝わらない操作名。ツールバー、行アクション、エディタ操作。
  • キーボードショートカット — 下記の例のように、ラベル横に Kbd でバインドを書く。
  • 切り詰められた短いテキスト — 長いファイル名、切れたテーブルセル、略したステータスコード。

インストール

以下のコマンドを実行してください。

pnpm dlx shadcn@latest add https://neobrutalism.com/r/base/tooltip.json
npx shadcn@latest add https://neobrutalism.com/r/base/tooltip.json
yarn dlx shadcn@latest add https://neobrutalism.com/r/base/tooltip.json
bunx --bun shadcn@latest add https://neobrutalism.com/r/base/tooltip.json

アプリのルートに TooltipProvider を追加してください。

app/layout.tsx
import { TooltipProvider } from "@/components/ui/tooltip"
 
export default function RootLayout({ children }) {
  return (
    <html lang="en">
      <body>
        <TooltipProvider>{children}</TooltipProvider>
      </body>
    </html>
  )
}

以下の依存関係をインストールしてください。

pnpm add @base-ui/react
npm install @base-ui/react
yarn add @base-ui/react
bun add @base-ui/react

以下のコードをコピーしてプロジェクトに貼り付けてください。

components/ui/tooltip.tsx
"use client"

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

import { cn } from "@/lib/utils"

function TooltipProvider({
  delayDuration = 0,
  ...props
}: React.ComponentProps<typeof TooltipPrimitive.Provider>) {
  return (
    <TooltipPrimitive.Provider
      data-slot="tooltip-provider"
      delayDuration={delayDuration}
      {...props}
    />
  )
}

function Tooltip({
  ...props
}: React.ComponentProps<typeof TooltipPrimitive.Root>) {
  return <TooltipPrimitive.Root data-slot="tooltip" {...props} />
}

function TooltipTrigger({
  ...props
}: React.ComponentProps<typeof TooltipPrimitive.Trigger>) {
  return <TooltipPrimitive.Trigger data-slot="tooltip-trigger" {...props} />
}

function TooltipContent({
  className,
  sideOffset = 0,
  children,
  ...props
}: React.ComponentProps<typeof TooltipPrimitive.Content>) {
  return (
    <TooltipPrimitive.Portal>
      <TooltipPrimitive.Content
        data-slot="tooltip-content"
        sideOffset={sideOffset}
        className={cn(
          "z-50 inline-flex w-fit max-w-xs origin-(--radix-tooltip-content-transform-origin) items-center gap-1.5 rounded border-2 bg-foreground px-2 py-1 text-xs text-background shadow-md 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-[state=delayed-open]:animate-in data-[state=delayed-open]:fade-in-0 data-[state=delayed-open]:zoom-in-95 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",
          className
        )}
        {...props}
      >
        {children}
        <TooltipPrimitive.Arrow className="z-50 size-2.5 translate-y-[calc(-50%_-_2px)] rotate-45 rounded-[2px] bg-foreground fill-foreground" />
      </TooltipPrimitive.Content>
    </TooltipPrimitive.Portal>
  )
}

export { Tooltip, TooltipContent, TooltipProvider, TooltipTrigger }

インポートパスをプロジェクトの構成に合わせて更新してください。

アプリのルートに TooltipProvider を追加してください。

app/layout.tsx
import { TooltipProvider } from "@/components/ui/tooltip"
 
export default function RootLayout({ children }) {
  return (
    <html lang="en">
      <body>
        <TooltipProvider>{children}</TooltipProvider>
      </body>
    </html>
  )
}

使い方

import {
  Tooltip,
  TooltipContent,
  TooltipTrigger,
} from "@/components/ui/tooltip"
<Tooltip>
  <TooltipTrigger>Hover</TooltipTrigger>
  <TooltipContent>
    <p>Add to library</p>
  </TooltipContent>
</Tooltip>

コンポジション

以下のコンポジションを使って Tooltip を構築します。

Tooltip
├── TooltipTrigger
└── TooltipContent

使用例

表示位置

side プロパティを使って、ツールチップの表示位置を変更します。

import { Button } from "@/components/ui/button"
import {
  Tooltip,

キーボードショートカット付き

import { SaveIcon } from "lucide-react"

import { Button } from "@/components/ui/button"

無効なボタン

無効なボタンを span で包むことで、そのボタンにツールチップを表示します。

import { Button } from "@/components/ui/button"
import {
  Tooltip,

RTL

Neobrutalism で RTL を有効にする方法は、RTL 設定ガイドをご覧ください。

"use client"

import {

アクセシビリティ

Tooltip は WAI-ARIA Tooltip パターン に従います。ポップアップは role="tooltip" を描画し、プリミティブがトリガーの aria-describedby をそこへ向けるため、スクリーンリーダーはヒントをコントロールの説明として読み上げます。ツールチップ自体はフォーカスを取りません。リンクやボタンは Popover に置き、ツールチップなしでもトリガーが理解できるようにしてください。

キーボード操作：

キー操作
Tab / Shift + Tabトリガーへフォーカスを移動 — フォーカスで開き、離れると閉じる
Escapeトリガーにフォーカスを残したままツールチップを閉じる
Enter / Spaceトリガー自身のアクションを起動 — ツールチップは説明でありコントロールではない

APIリファレンス

詳しくは Base UI のドキュメントをご覧ください。