overlays

Tooltip

Display content that appears on hover next to an element.

Usage

<template>
  <UTooltip text="Tooltip example" :shortcuts="['⌘', 'O']">
    <UButton color="gray" label="Hover me" />
  </UTooltip>
</template>

Slots

text

Use the #text slot to override the content of the text.

Hover
<UTooltip>
  <template #text>
    <span class="italic">Hello World!</span>
  </template>
</UTooltip>

Props

ui
any

undefined

text
string

null

popper
{}

{}

openDelay
number

0

closeDelay
number

0

shortcuts
string[]

[]

prevent
boolean

false

Preset

{
  "wrapper": "relative inline-flex",
  "container": "z-20",
  "width": "max-w-xs",
  "background": "bg-white dark:bg-gray-900",
  "color": "text-gray-900 dark:text-white",
  "shadow": "shadow",
  "rounded": "rounded",
  "ring": "ring-1 ring-gray-200 dark:ring-gray-800",
  "base": "[@media(pointer:coarse)]:hidden h-6 px-2 py-1 text-xs font-normal truncate",
  "shortcuts": "hidden md:inline-flex flex-shrink-0 gap-0.5",
  "transition": {
    "enterActiveClass": "transition ease-out duration-200",
    "enterFromClass": "opacity-0 translate-y-1",
    "enterToClass": "opacity-100 translate-y-0",
    "leaveActiveClass": "transition ease-in duration-150",
    "leaveFromClass": "opacity-100 translate-y-0",
    "leaveToClass": "opacity-0 translate-y-1"
  },
  "popper": {
    "strategy": "fixed"
  }
}