Tooltip

Inline tooltip wrapper for supplemental labels.

A live, theme-aware example rendered with the published component.

Import

Import the component from its dedicated entry point to keep the dependency and generated bundle explicit.

TSX

tsximport { Tooltip } from "@tavojs/ui/tooltip";

Normal Tavo.js applications load component styles through the Tavo.js UI plugin. If the application manages component CSS manually, also import @tavojs/ui/css/tooltip.

When to use

Use it when

Use `Tooltip` for short contextual hints

Choose something else when

Avoid Tooltip when using feedback components as primary page layout.

Examples

Tooltip example

TSX

tsximport { Tooltip } from "@tavojs/ui/tooltip";
import { Button } from "@tavojs/ui";

export function TooltipExample1() {
  return (
    <>
      <Tooltip content="Export report"><Button>Export</Button></Tooltip>
    </>
  );
}

Common props and defaults

Prop	Type	Default	Description
`className`	`string`	—	Optional class hook applied to the public root element owned by the component.
`content`	`Child`	Required	Configures content for this component.
`side`	`"top" \| "right" \| "bottom" \| "left"`	—	Configures side for this component.

Complete TypeScript API

Import from @tavojs/ui/tooltip. Published exports: Tooltip, TooltipProps.

`TooltipProps`

Property	Type	Required	Description
`children`	`Child`	No	Inherited children attribute accepted by Tooltip.
`className`	`string`	No	Optional class hook applied to the public root element owned by the component.
`sx`	`Sx`	No	Inherited sx attribute accepted by Tooltip.
`id`	`string`	No	Inherited id attribute accepted by Tooltip.
`role`	`string`	No	Inherited role attribute accepted by Tooltip.
`style`	`Record<string, unknown>`	No	Inherited style attribute accepted by Tooltip.
`title`	`string`	No	Inherited title attribute accepted by Tooltip.
`tabIndex`	`number`	No	Inherited tabIndex attribute accepted by Tooltip.
`hidden`	`boolean`	No	Inherited hidden attribute accepted by Tooltip.
`disabled`	`boolean`	No	Inherited disabled attribute accepted by Tooltip.
`onClick`	`TavoEventHandler<MouseEvent>`	No	Inherited onClick attribute accepted by Tooltip.
`onChange`	`TavoEventHandler<Event>`	No	Inherited onChange attribute accepted by Tooltip.
`onInput`	`TavoEventHandler<Event>`	No	Inherited onInput attribute accepted by Tooltip.
`onKeyDown`	`TavoEventHandler<KeyboardEvent>`	No	Inherited onKeyDown attribute accepted by Tooltip.
`onFocus`	`TavoEventHandler<FocusEvent>`	No	Inherited onFocus attribute accepted by Tooltip.
`onBlur`	`TavoEventHandler<FocusEvent>`	No	Inherited onBlur attribute accepted by Tooltip.
`content`	`Child`	Yes	Configures content for this component.
`side`	`"left" \| "right" \| "top" \| "bottom"`	No	Configures side for this component.

State ownership and DOM target

Concern	Contract
State	No component state contract is exposed; the application owns the rendered content and surrounding behavior.
DOM target	Public passthrough props target the component root. Treat nested elements and private class names as implementation details.

Anatomy and related components

This component exposes one public component root rather than a compound member API.

Limitations

Avoid Tooltip when using feedback components as primary page layout.

Use only the documented props, entry points, and compound members. Internal DOM nesting and CSS class names can change without becoming part of the public component contract.

Accessibility

Feedback components should announce status changes and manage focus only when the component owns that behavior.

Use Dialog, Sheet, or FocusTrap for modal workflows.
Use Toast or native live-region semantics for dynamic announcements.
Make dismiss and escape behavior clear for overlays.

Component status

Contract	Current value
Maturity	stable
Category	feedback
Component import	`@tavojs/ui/tooltip`
Explicit CSS import	`@tavojs/ui/css/tooltip`
Preview	Interactive preview available on this page

Preview

Tooltip example

TooltipProps

`TooltipProps`