Explain an icon
Add short supplementary help to an already named control.
Components / Overlays
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.
bunx --bun @getweini/cli@latest add tooltipImport 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.
<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.
Add short supplementary help to an already named control.
Explain a label on focus and hover without requiring a separate help page.
The trigger has its own accessible name; the tooltip adds description.
<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>Adjust the hover delay for a dense interface.
<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>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.
| Name | Type or signature | Default | What it does |
|---|---|---|---|
disabledprop | boolean | undefined | Not set | Prevent interaction and show the disabled state. |
delayprop | number | undefined | 400 | Time to wait before showing this content. |
closeDelayprop | number | undefined | 120 | Time to wait before closing after the pointer leaves. |
widthprop | number | undefined | 240 | Choose the width of this content. |
gapprop | number | undefined | 12 | Space 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. |
describedbyprop | string | undefined | Not set | ID of the text that describes this control. |
triggerslot | { props: TooltipTriggerProps; } | Optional | Content for the trigger area of Tooltip. |
defaultslot | {} | Optional | Content shown inside Tooltip. |
| Name | Type or signature | Default | What it does |
|---|---|---|---|
defaultslot | {} | Optional | Content shown inside TooltipContent. |
| Name | Type or signature | Default | What it does |
|---|---|---|---|
asChildprop | boolean | undefined | Not set | Use one child element as the control instead of adding another wrapper. |
defaultslot | {} | Optional | Content shown inside TooltipTrigger. |
// 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
}