Skip to main content
Vuetify0 is now in beta!
Vuetify0 Logo
Theme
Mode
Palettes
Accessibility
Vuetify One
Sign in to Vuetify One

Access premium tools across the Vuetify ecosystem — Bin, Play, Studio, and more.

Not a subscriber? See what's included

useTooltip

Region-scoped coordination plugin for tooltip open/close delays. Holds shared openDelay / closeDelay / skipDelay defaults plus a registry of currently-open tooltip tickets so neighboring <Tooltip.Root> instances can skip their open delay during the warmup window.

Usage

ts
import { createTooltipPlugin, useTooltip } from '@vuetify/v0'

// App-wide defaults
app.use(
  createTooltipPlugin({
    openDelay: 500,
    closeDelay: 150,
    skipDelay: 300,
  })
)

// Inside a component
const region = useTooltip()

region.openDelay.value          // 500
region.isAnyOpen.value          // false
region.shouldSkipOpenDelay()    // false until a tooltip opens

<Tooltip.Root> reads from useTooltip() automatically; you do not call this composable yourself unless you’re building a non-component consumer.

Architecture

Reactivity

PropertyTypeDescription
openDelayReadonly<Ref<number>>Default open delay in ms (700)
closeDelayReadonly<Ref<number>>Default close delay in ms (150)
skipDelayReadonly<Ref<number>>Skip-window after last close in ms (300)
disabledReadonly<Ref<boolean>>Region-wide disabled flag
isAnyOpenReadonly<Ref<boolean>>True when any registered tooltip is currently open
shouldSkipOpenDelay() => booleanWhether the next open should bypass the delay
register(input?: Partial<RegistryTicketInput>) => RegistryTicketTrack a newly-opened tooltip
unregister(id: ID) => voidUntrack a closed tooltip

Examples

FAQ

API Reference

The following API details are for the useTooltip composable.
Was this page helpful?

Ctrl+/