Navigated to /docs/ui/components/hover-card

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.

TSX
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

Use HoverCard when you need hover and focus card for supplemental contextual content.

Choose something else when

Avoid HoverCard when using feedback components as primary page layout.

Examples

HoverCard example

TSX
tsximport { HoverCard } from "@tavojs/ui/hover-card";

export function HoverCardExample1() {
  return (
    <>
      <HoverCard />
    </>
  );
}

Common props and defaults

PropTypeDefaultDescription
classNamestring

Optional class hook applied to the public root element owned by the component.
toneTone

Semantic tone where status messaging is supported. Applies to HoverCard.
openboolean

Controlled visibility state for overlay-style components when supported. Applies to HoverCard.
childrenChild

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

PropertyTypeRequiredDescription
childrenChild

No

Feedback message or overlay content. Applies to HoverCard.

classNamestring

No

Optional class hook applied to the public root element owned by the component.

sxSx

No

Inherited sx attribute accepted by HoverCard.

idstring

No

Inherited id attribute accepted by HoverCard.

rolestring

No

Inherited role attribute accepted by HoverCard.

styleRecord<string, unknown>

No

Inherited style attribute accepted by HoverCard.

titlestring

No

Inherited title attribute accepted by HoverCard.

tabIndexnumber

No

Inherited tabIndex attribute accepted by HoverCard.

hiddenboolean

No

Inherited hidden attribute accepted by HoverCard.

disabledboolean

No

Inherited disabled attribute accepted by HoverCard.

onClickTavoEventHandler<MouseEvent>

No

Inherited onClick attribute accepted by HoverCard.

onChangeTavoEventHandler<Event>

No

Inherited onChange attribute accepted by HoverCard.

onInputTavoEventHandler<Event>

No

Inherited onInput attribute accepted by HoverCard.

onKeyDownTavoEventHandler<KeyboardEvent>

No

Inherited onKeyDown attribute accepted by HoverCard.

onFocusTavoEventHandler<FocusEvent>

No

Inherited onFocus attribute accepted by HoverCard.

onBlurTavoEventHandler<FocusEvent>

No

Inherited onBlur attribute accepted by HoverCard.

HoverCardTriggerProps

PropertyTypeRequiredDescription
childrenChild

No

Feedback message or overlay content. Applies to HoverCard.

classNamestring

No

Optional class hook applied to the public root element owned by the component.

sxSx

No

Inherited sx attribute accepted by HoverCard.

idstring

No

Inherited id attribute accepted by HoverCard.

rolestring

No

Inherited role attribute accepted by HoverCard.

styleRecord<string, unknown>

No

Inherited style attribute accepted by HoverCard.

titlestring

No

Inherited title attribute accepted by HoverCard.

tabIndexnumber

No

Inherited tabIndex attribute accepted by HoverCard.

hiddenboolean

No

Inherited hidden attribute accepted by HoverCard.

disabledboolean

No

Inherited disabled attribute accepted by HoverCard.

onClickTavoEventHandler<MouseEvent>

No

Inherited onClick attribute accepted by HoverCard.

onChangeTavoEventHandler<Event>

No

Inherited onChange attribute accepted by HoverCard.

onInputTavoEventHandler<Event>

No

Inherited onInput attribute accepted by HoverCard.

onKeyDownTavoEventHandler<KeyboardEvent>

No

Inherited onKeyDown attribute accepted by HoverCard.

onFocusTavoEventHandler<FocusEvent>

No

Inherited onFocus attribute accepted by HoverCard.

onBlurTavoEventHandler<FocusEvent>

No

Inherited onBlur attribute accepted by HoverCard.

HoverCardContentProps

PropertyTypeRequiredDescription
childrenChild

No

Feedback message or overlay content. Applies to HoverCard.

classNamestring

No

Optional class hook applied to the public root element owned by the component.

sxSx

No

Inherited sx attribute accepted by HoverCard.

idstring

No

Inherited id attribute accepted by HoverCard.

rolestring

No

Inherited role attribute accepted by HoverCard.

styleRecord<string, unknown>

No

Inherited style attribute accepted by HoverCard.

titlestring

No

Inherited title attribute accepted by HoverCard.

tabIndexnumber

No

Inherited tabIndex attribute accepted by HoverCard.

hiddenboolean

No

Inherited hidden attribute accepted by HoverCard.

disabledboolean

No

Inherited disabled attribute accepted by HoverCard.

onClickTavoEventHandler<MouseEvent>

No

Inherited onClick attribute accepted by HoverCard.

onChangeTavoEventHandler<Event>

No

Inherited onChange attribute accepted by HoverCard.

onInputTavoEventHandler<Event>

No

Inherited onInput attribute accepted by HoverCard.

onKeyDownTavoEventHandler<KeyboardEvent>

No

Inherited onKeyDown attribute accepted by HoverCard.

onFocusTavoEventHandler<FocusEvent>

No

Inherited onFocus attribute accepted by HoverCard.

onBlurTavoEventHandler<FocusEvent>

No

Inherited onBlur attribute accepted by HoverCard.

State ownership and DOM target

ConcernContract
StateApplication controlled through open and the matching callback.
DOM targetPublic passthrough props target the component root. Treat nested elements and private class names as implementation details.

Anatomy and related components

Public compound members: Root, Trigger, Content

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

ContractCurrent value
Maturitystable
Categoryfeedback
Component import@tavojs/ui/hover-card
Explicit CSS import@tavojs/ui/css/hover-card
PreviewInteractive preview available on this page