Setup
<script lang="ts">
import { Button, Tooltip } from '@cailabs/components.base';
</script> Default tooltip
<script lang="ts">
import { Button, Tooltip } from '@cailabs/components.base';
</script>
<Button id="tip-default">Hover me</Button>
<Tooltip triggeredBy="#tip-default">Tooltip content</Tooltip> Placement
<script lang="ts">
import { Button, Tooltip } from '@cailabs/components.base';
</script>
<Button id="tip-top">Top</Button>
<Tooltip triggeredBy="#tip-top" placement="top">Top tooltip</Tooltip> Light type
<script lang="ts">
import { Button, Tooltip } from '@cailabs/components.base';
</script>
<Button id="tip-light">Light tooltip</Button>
<Tooltip triggeredBy="#tip-light" type="light">Light style</Tooltip> Colors
Optional color tokens (override type fill): primary, secondary, gray, red, orange, amber, yellow, lime, green, emerald, teal, cyan, sky, blue, indigo, violet, purple, fuchsia, pink, rose.
type variants: dark, light, auto, custom.
Composition notes
- Always pair with a trigger element and set
triggeredByto its selector (usually#id). - Prefer
trigger="hover"for tooltips; use click for touch-friendly tips. - Extends the shared Popper API used by Dropdown / Popover.
Props
TooltipProps (extends PopperProps)
| Prop | Type | Default | Description |
|---|---|---|---|
children | Snippet | — | Tooltip content |
type | dark | light | auto | custom | dark | Visual style |
color | color token | — | Solid color override |
triggeredBy | string | — | CSS selector for trigger |
trigger | hover | click | hover | Open behavior |
triggerDelay | number | — | Hover delay (ms) |
placement | Floating UI Placement | top | Position |
strategy | Floating UI Strategy | — | absolute / fixed |
offset | number | — | Distance from trigger |
arrow | boolean | true | Show arrow |
arrowClass | string | — | Arrow classes |
reference | string | — | Alternate reference selector |
middlewares | Middleware[] | — | Floating UI middleware |
yOnly | boolean | — | Constrain movement to Y |
isOpen | boolean | false | Bindable open state |
transition | TransitionFunc | — | Open/close transition |
transitionParams | ParamsType | — | Transition params |
onbeforetoggle | (ev) => void | — | Before open/close |
ontoggle | (ev) => void | — | After open/close |
class | ClassValue | — | Root classes |
Events
| Event | Description |
|---|---|
onbeforetoggle | Before visibility change (TriggeredToggleEvent) |
ontoggle | After visibility change |