HoverCard

Hover and focus card for supplemental contextual content.

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

Import

Import from the focused entry point below, or use the same named export from @tavojs/ui. Both are public APIs; measure the built application when comparing their bundle cost.

TSX

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

The component import loads compiled component CSS. Enable tavoUi() for your project theme variables, or import @tavojs/ui/theme.css once for the package default theme. The equivalent CSS-safe component alias is @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

These examples include imports and local state where interaction requires it. Render the exported component in a page after completing UI installation. Demo state stays in the mounted component; connect file handling, persistence, and data loading to your application as needed.

HoverCard example

TSXCreate: src/components/examples/HoverCardExample1.tsx

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

export function HoverCardExample1() {
  return (
    <>
      <HoverCard>
        <HoverCard.Trigger>Platform team</HoverCard.Trigger>
        <HoverCard.Content>Maintains shared infrastructure and developer tooling.</HoverCard.Content>
      </HoverCard>
    </>
  );
}

Common props and defaults

A curated starting point. The complete TypeScript API below includes additional props and compound member contracts.

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	Use open to supply rendered state. Update it through the documented callback or native event handler.
DOM target	Public 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

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

Preview

HoverCard example

HoverCardProps

HoverCardTriggerProps

HoverCardContentProps

`HoverCardProps`

`HoverCardTriggerProps`

`HoverCardContentProps`