HoverCard
Hover and focus card for supplemental contextual content.
Preview
A live, theme-aware example rendered with the published component.
Loading preview…
Import
Import the component from its dedicated entry point to keep the dependency and generated bundle explicit.
tsximport { HoverCard } from "@tavojs/ui/hover-card";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/hover-card.
When to use
Use it when
Choose something else when
Examples
HoverCard example
tsximport { HoverCard } from "@tavojs/ui/hover-card";
export function HoverCardExample1() {
return (
<>
<HoverCard />
</>
);
}Common props and defaults
| Prop | Type | Default | Description |
|---|---|---|---|
className | string | — | Optional class hook applied to the public root element owned by the component. |
tone | Tone | — | Semantic tone where status messaging is supported. Applies to HoverCard. |
open | boolean | — | Controlled visibility state for overlay-style components when supported. Applies to HoverCard. |
children | Child | — | Feedback message or overlay content. Applies to HoverCard. |
Complete TypeScript API
Import from @tavojs/ui/hover-card. Published exports: HoverCard, HoverCardContent, HoverCardContentProps, HoverCardProps, HoverCardRoot, HoverCardTrigger, HoverCardTriggerProps.
HoverCardProps
| Property | Type | Required | Description |
|---|---|---|---|
children | Child | No | Feedback message or overlay content. Applies to HoverCard. |
className | string | No | Optional class hook applied to the public root element owned by the component. |
sx | Sx | No | Inherited sx attribute accepted by HoverCard. |
id | string | No | Inherited id attribute accepted by HoverCard. |
role | string | No | Inherited role attribute accepted by HoverCard. |
style | Record<string, unknown> | No | Inherited style attribute accepted by HoverCard. |
title | string | No | Inherited title attribute accepted by HoverCard. |
tabIndex | number | No | Inherited tabIndex attribute accepted by HoverCard. |
hidden | boolean | No | Inherited hidden attribute accepted by HoverCard. |
disabled | boolean | No | Inherited disabled attribute accepted by HoverCard. |
onClick | TavoEventHandler<MouseEvent> | No | Inherited onClick attribute accepted by HoverCard. |
onChange | TavoEventHandler<Event> | No | Inherited onChange attribute accepted by HoverCard. |
onInput | TavoEventHandler<Event> | No | Inherited onInput attribute accepted by HoverCard. |
onKeyDown | TavoEventHandler<KeyboardEvent> | No | Inherited onKeyDown attribute accepted by HoverCard. |
onFocus | TavoEventHandler<FocusEvent> | No | Inherited onFocus attribute accepted by HoverCard. |
onBlur | TavoEventHandler<FocusEvent> | No | Inherited onBlur attribute accepted by HoverCard. |
HoverCardTriggerProps
| Property | Type | Required | Description |
|---|---|---|---|
children | Child | No | Feedback message or overlay content. Applies to HoverCard. |
className | string | No | Optional class hook applied to the public root element owned by the component. |
sx | Sx | No | Inherited sx attribute accepted by HoverCard. |
id | string | No | Inherited id attribute accepted by HoverCard. |
role | string | No | Inherited role attribute accepted by HoverCard. |
style | Record<string, unknown> | No | Inherited style attribute accepted by HoverCard. |
title | string | No | Inherited title attribute accepted by HoverCard. |
tabIndex | number | No | Inherited tabIndex attribute accepted by HoverCard. |
hidden | boolean | No | Inherited hidden attribute accepted by HoverCard. |
disabled | boolean | No | Inherited disabled attribute accepted by HoverCard. |
onClick | TavoEventHandler<MouseEvent> | No | Inherited onClick attribute accepted by HoverCard. |
onChange | TavoEventHandler<Event> | No | Inherited onChange attribute accepted by HoverCard. |
onInput | TavoEventHandler<Event> | No | Inherited onInput attribute accepted by HoverCard. |
onKeyDown | TavoEventHandler<KeyboardEvent> | No | Inherited onKeyDown attribute accepted by HoverCard. |
onFocus | TavoEventHandler<FocusEvent> | No | Inherited onFocus attribute accepted by HoverCard. |
onBlur | TavoEventHandler<FocusEvent> | No | Inherited onBlur attribute accepted by HoverCard. |
HoverCardContentProps
| Property | Type | Required | Description |
|---|---|---|---|
children | Child | No | Feedback message or overlay content. Applies to HoverCard. |
className | string | No | Optional class hook applied to the public root element owned by the component. |
sx | Sx | No | Inherited sx attribute accepted by HoverCard. |
id | string | No | Inherited id attribute accepted by HoverCard. |
role | string | No | Inherited role attribute accepted by HoverCard. |
style | Record<string, unknown> | No | Inherited style attribute accepted by HoverCard. |
title | string | No | Inherited title attribute accepted by HoverCard. |
tabIndex | number | No | Inherited tabIndex attribute accepted by HoverCard. |
hidden | boolean | No | Inherited hidden attribute accepted by HoverCard. |
disabled | boolean | No | Inherited disabled attribute accepted by HoverCard. |
onClick | TavoEventHandler<MouseEvent> | No | Inherited onClick attribute accepted by HoverCard. |
onChange | TavoEventHandler<Event> | No | Inherited onChange attribute accepted by HoverCard. |
onInput | TavoEventHandler<Event> | No | Inherited onInput attribute accepted by HoverCard. |
onKeyDown | TavoEventHandler<KeyboardEvent> | No | Inherited onKeyDown attribute accepted by HoverCard. |
onFocus | TavoEventHandler<FocusEvent> | No | Inherited onFocus attribute accepted by HoverCard. |
onBlur | TavoEventHandler<FocusEvent> | No | Inherited onBlur attribute accepted by HoverCard. |
State ownership and DOM target
| Concern | Contract |
|---|---|
| State | Application controlled through open and the matching callback. |
| DOM target | Public passthrough props target the component root. Treat nested elements and private class names as implementation details. |
Anatomy and related components
Limitations
Avoid HoverCard 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/hover-card |
| Explicit CSS import | @tavojs/ui/css/hover-card |
| Preview | Interactive preview available on this page |