ナビゲーションと開示@neumorphism-ui/tooltip

Tooltip

Base UI Tooltip を基盤に Provider、Root、Trigger、Portal、Positioner、Popup を組み合わせます。既定の provider delay は250msで、popup は trigger 周辺の衝突を自動的に回避します。

@neumorphism-ui/tooltip
Registry JSON

プレビュー

ボタンに hover するか focus を移してください。

インストール

インストール: tooltipnpx shadcn@latest add @neumorphism-ui/tooltip

CLI が npm 依存関係、base token、utils、コンポーネントソースを順番に処理します。

この Registry を初めて使う場合は、先に namespace の設定 を完了してください。

使い方

使い方: インストールnpx shadcn@latest add @neumorphism-ui/button @neumorphism-ui/tooltip

Import

Tooltip の import コード
import { Button } from "@/components/ui/button"
import {
  Tooltip,
  TooltipContent,
  TooltipProvider,
  TooltipTrigger,
} from "@/components/ui/tooltip"

Example

Tooltip の使用コード
<TooltipProvider>
  <Tooltip>
    <TooltipTrigger
      render={<Button size="icon" aria-label="設定を開く" />}
    >
      ⚙
    </TooltipTrigger>
    <TooltipContent side="top">
      設定
    </TooltipContent>
  </Tooltip>
</TooltipProvider>

API リファレンス

コンポーネントプロパティ型デフォルト説明
TooltipProviderdelaynumber250pointer hover 後に tooltip を開くまでの遅延時間(ms)です。
Tooltipopen / defaultOpenbooleanfalse制御された open 状態、または非制御時の初期 open 状態です。
TooltiponOpenChange(open: boolean) => void—open 状態が変わったときに呼び出されます。
TooltipTriggerrenderReactElement | (props, state) => ReactElement—button または link に tooltip trigger の動作を合成します。
TooltipContentside / align"top" | "right" | "bottom" | "left" / "start" | "center" | "end""top" / "center"trigger を基準に popup を配置します。
TooltipContentsideOffsetnumber8trigger と popup の間隔です。

アクセシビリティ

  • 01

    Tooltip は trigger のアクセシブルな名前を置き換えないため、icon button には引き続き aria-label が必要です。

  • 02

    内容は短い補足にとどめ、必須の手順やエラーメッセージを Tooltip だけに配置しないでください。

  • 03

    Base UI は hover だけでなくキーボード focus でも Tooltip を開き、Escape で閉じます。