Skip to content

Search documentation

Search guides, examples, and component APIs.

Quick links
↑↓ NavigateEnter OpenEsc Close
Get started

Documentation navigation

Components / Overlays

Tooltip

Short, non-interactive help on hover or focus.

Last changed in version 0.14.2: Improve keyboard navigation, action feedback, and selected colors across Vue components.

Interactive showcase

Install

Run in your project
bunx --bun @getweini/cli@latest add tooltip

Start with this example

Import the files copied by the install command, then place the component in your Vue template. The text and values in the example belong to your app; change them to fit your task.

Vue
<script setup lang="ts">
import Tooltip from './components/ui/tooltip/Tooltip.vue'
import TooltipContent from './components/ui/tooltip/TooltipContent.vue'
import TooltipTrigger from './components/ui/tooltip/TooltipTrigger.vue'
</script>

<template>
  <Tooltip>
    <TooltipTrigger aria-label="Keyboard help">?</TooltipTrigger>
    <TooltipContent>Use arrow keys to move through options.</TooltipContent>
  </Tooltip>
</template>

The trigger still needs its own accessible name. The arrow follows the trigger when collision handling shifts the tooltip. Use Popover when the content has controls.

When to use it

Explain an icon

Add short supplementary help to an already named control.

Clarify a term

Explain a label on focus and hover without requiring a separate help page.

More examples

Keyboard help

The trigger has its own accessible name; the tooltip adds description.

Keyboard help
<script setup lang="ts">
import Tooltip from './components/ui/tooltip/Tooltip.vue'
import TooltipContent from './components/ui/tooltip/TooltipContent.vue'
import TooltipTrigger from './components/ui/tooltip/TooltipTrigger.vue'
</script>
<template>
  <Tooltip>
    <TooltipTrigger aria-label="Keyboard help">?</TooltipTrigger>
    <TooltipContent>Use arrow keys to move between options.</TooltipContent>
  </Tooltip>
</template>

Delayed explanation

Adjust the hover delay for a dense interface.

Delayed explanation
<script setup lang="ts">
import Tooltip from './components/ui/tooltip/Tooltip.vue'
import TooltipContent from './components/ui/tooltip/TooltipContent.vue'
import TooltipTrigger from './components/ui/tooltip/TooltipTrigger.vue'
</script>
<template>
  <Tooltip :delay="700" side="bottom">
    <TooltipTrigger>Sync status</TooltipTrigger>
    <TooltipContent>Changes sync when you are online.</TooltipContent>
  </Tooltip>
</template>

Complete API

Every public prop, model, event, slot, and exposed member of the installed Vue parts is listed below. “Not set” means you can leave that value out; “Required” means you must provide it. Native HTML attributes also work where the component uses a native element.

Tooltip

Complete API for Tooltip
NameType or signatureDefaultWhat it does
disabledpropboolean | undefinedNot setPrevent interaction and show the disabled state.
delaypropnumber | undefined400Time to wait before showing this content.
closeDelaypropnumber | undefined120Time to wait before closing after the pointer leaves.
widthpropnumber | undefined240Choose the width of this content.
gappropnumber | undefined12Space in pixels between the trigger and floating content.
alignprop"start" | "end" | "center" | undefined"center"Choose how content aligns within its container.
sideprop"top" | "bottom" | undefined"top"Choose the side on which this content appears.
describedbypropstring | undefinedNot setID of the text that describes this control.
triggerslot{ props: TooltipTriggerProps; }OptionalContent for the trigger area of Tooltip.
defaultslot{}OptionalContent shown inside Tooltip.

TooltipContent

Complete API for TooltipContent
NameType or signatureDefaultWhat it does
defaultslot{}OptionalContent shown inside TooltipContent.

TooltipTrigger

Complete API for TooltipTrigger
NameType or signatureDefaultWhat it does
asChildpropboolean | undefinedNot setUse one child element as the control instead of adding another wrapper.
defaultslot{}OptionalContent shown inside TooltipTrigger.
Public type definitions
Public types
// packages/frameworks/vue/components/tooltip/types.ts
// ------- TYPES -------

export interface TooltipProps {
  disabled?: boolean
  delay?: number
  closeDelay?: number
  width?: number
  gap?: number
  align?: 'start' | 'center' | 'end'
  side?: 'top' | 'bottom'
  describedby?: string
}

export interface TooltipTriggerComponentProps {
  asChild?: boolean
}

Implementation notes

  • TooltipContent is noninteractive; use Popover for links or controls.
  • Focus opens immediately, while pointer hover respects delay and closeDelay.

Accessibility and localization

  • The trigger must have a name without relying on tooltip text.
  • Keep essential instructions visible elsewhere; touch users do not get hover-only content.

Source contract and editing guidance