Перейти к содержимому
1.6k

Подсказка

Подсказки при наведении курсора и при фокусировке для кнопок с пиктограммами, сочетаний клавиш и сокращённых меток — с использованием необруталистского стиля оформления с рамками и тенями.

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

Tooltip — короткая подпись, появляющаяся по hover или keyboard focus и описывающая обёрнутый контрол: supplemental-текст, никогда не место для интерактивного контента. Построен на примитиве Base UI Tooltip, portalled и collision-aware, и оформлен по рецепту необрутализма: толстая рамка, жёсткая тень и inverted fill, чтобы читался на любом фоне.

Когда это пригодится:

  • Кнопки-иконки — назвать действие, которое голая иконка не объясняет: тулбары, row actions, controls редактора.
  • Клавиатурные shortcut'ы — пропишите binding рядом с label через Kbd, как в примере ниже.
  • Обрезанный или сжатый текст — полные имена файлов, clipped-ячейки таблиц, abbreviated status codes.

Установка

Выполните следующую команду:

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

Чтобы включить поддержку RTL в Neobrutalism, см. руководство по настройке RTL.

"use client"

import {

Доступность

Tooltip следует паттерну WAI-ARIA Tooltip: popup рендерится с role="tooltip", а примитив указывает aria-describedby триггера на него, поэтому программы чтения с экрана объявляют подсказку как description контрола. Сам tooltip фокус не принимает — ссылки и кнопки кладите в Popover, а триггер делайте понятным и без него.

Клавиатурные взаимодействия:

КлавишаДействие
Tab / Shift + TabПеревести фокус на триггер — фокус открывает tooltip, уход закрывает
EscapeСкрыть tooltip, оставив фокус на триггере
Enter / SpaceАктивировать собственное действие триггера — tooltip это description, не контрол

Справочник API

См. документацию Base UI Tooltip.