Skip to content
WebJs
Menu

For sighted users to preview content available behind a link.

import { html } from '@webjsdev/core';
import { buttonClass } from '#components/ui/button.ts';

export default function HoverCardDemo() {
  return html`
    <ui-hover-card open-delay="10" close-delay="100">
      <ui-hover-card-trigger>
        <button type="button" data-slot="button" data-variant="link" data-size="default" class=${buttonClass({ variant: 'link' })}>Hover Here</button>
      </ui-hover-card-trigger>
      <ui-hover-card-content>
        <div class="flex w-64 flex-col gap-0.5">
          <div data-slot="hover-card-title" class="font-semibold">@nextjs</div>
          <div>The React Framework – created and maintained by @vercel.</div>
          <div class="mt-1 text-xs text-muted-foreground">Joined December 2021</div>
        </div>
      </ui-hover-card-content>
    </ui-hover-card>
  `;
}
View Code

Installation

pnpm dlx @webjsdev/ui add hover-card

Usage

import '#components/ui/hover-card.ts';
<ui-hover-card>
  <ui-hover-card-trigger>
    <a href="https://nextjs.org">Hover</a>
  </ui-hover-card-trigger>
  <ui-hover-card-content>
    The React Framework – created and maintained by @vercel.
  </ui-hover-card-content>
</ui-hover-card>

Composition

Use the following composition to build a hover card:

ui-hover-card
├── ui-hover-card-trigger
└── ui-hover-card-content

Trigger Delays

Use open-delay and close-delay on <ui-hover-card> to control when the card opens and closes.

<ui-hover-card open-delay="100" close-delay="200">
  <ui-hover-card-trigger><a href="#">Hover</a></ui-hover-card-trigger>
  <ui-hover-card-content>Content</ui-hover-card-content>
</ui-hover-card>

Positioning

Use the side and align attributes on <ui-hover-card-content> to control placement.

<ui-hover-card>
  <ui-hover-card-trigger><a href="#">Hover</a></ui-hover-card-trigger>
  <ui-hover-card-content side="top" align="start">
    Content
  </ui-hover-card-content>
</ui-hover-card>

Basic

import { html } from '@webjsdev/core';
import { buttonClass } from '#components/ui/button.ts';

export default function HoverCardDemo() {
  return html`
    <ui-hover-card open-delay="10" close-delay="100">
      <ui-hover-card-trigger>
        <button type="button" data-slot="button" data-variant="link" data-size="default" class=${buttonClass({ variant: 'link' })}>Hover Here</button>
      </ui-hover-card-trigger>
      <ui-hover-card-content>
        <div class="flex w-64 flex-col gap-0.5">
          <div data-slot="hover-card-title" class="font-semibold">@nextjs</div>
          <div>The React Framework – created and maintained by @vercel.</div>
          <div class="mt-1 text-xs text-muted-foreground">Joined December 2021</div>
        </div>
      </ui-hover-card-content>
    </ui-hover-card>
  `;
}
View Code

Sides

import { html } from '@webjsdev/core';
import { cn } from '#lib/utils/cn.ts';
import { buttonClass } from '#components/ui/button.ts';

const HOVER_CARD_SIDES = ['left', 'top', 'bottom', 'right'] as const;

export default function HoverCardSides() {
  return html`
    <div class="flex flex-wrap justify-center gap-2">
      ${HOVER_CARD_SIDES.map((side) => html`
        <ui-hover-card open-delay="100" close-delay="100">
          <ui-hover-card-trigger>
            <button type="button" data-slot="button" data-variant="outline" data-size="default" class=${cn(buttonClass({ variant: 'outline' }), 'capitalize')}>${side}</button>
          </ui-hover-card-trigger>
          <ui-hover-card-content side=${side}>
            <div class="flex flex-col gap-1">
              <h4 data-slot="hover-card-title" class="font-medium">Hover Card</h4>
              <p>This hover card appears on the ${side} side of the trigger.</p>
            </div>
          </ui-hover-card-content>
        </ui-hover-card>
      `)}
    </div>
  `;
}
View Code

RTL

To enable RTL support, see the RTL configuration guide.

import { html } from '@webjsdev/core';
import { buttonClass } from '#components/ui/button.ts';

const translations = {
  en: {
    dir: 'ltr',
    values: {
      trigger: 'Wireless Headphones',
      name: 'Wireless Headphones',
      price: '$99.99',
      left: 'Left',
      top: 'Top',
      bottom: 'Bottom',
      right: 'Right',
    },
  },
  ar: {
    dir: 'rtl',
    values: {
      trigger: 'سماعات لاسلكية',
      name: 'سماعات لاسلكية',
      price: '٩٩.٩٩ $',
      left: 'يسار',
      top: 'أعلى',
      bottom: 'أسفل',
      right: 'يمين',
    },
  },
  he: {
    dir: 'rtl',
    values: {
      trigger: 'אוזניות אלחוטיות',
      name: 'אוזניות אלחוטיות',
      price: '99.99 $',
      left: 'שמאל',
      top: 'למעלה',
      bottom: 'למטה',
      right: 'ימין',
    },
  },
};

const physicalSides = ['left', 'top', 'bottom', 'right'] as const;

export default function HoverCardRtl() {
  const lang = 'ar';
  const { dir, values: t } = translations[lang];

  return html`
    <div class="flex flex-wrap justify-center gap-2" dir=${dir} lang=${lang}>
      ${physicalSides.map((side) => html`
        <ui-hover-card open-delay="10" close-delay="100">
          <ui-hover-card-trigger>
            <button type="button" data-slot="button" data-variant="outline" data-size="default" class=${buttonClass({ variant: 'outline' })}>${t[side]}</button>
          </ui-hover-card-trigger>
          <ui-hover-card-content side=${side} class="flex w-64 flex-col gap-1" dir=${dir}>
            <div data-slot="hover-card-title" class="font-semibold">${t.name}</div>
            <div class="text-sm text-muted-foreground">${t.price}</div>
          </ui-hover-card-content>
        </ui-hover-card>
      `)}
    </div>
  `;
}
View Code

API Reference

The card is a native popover="manual" element in the top layer, positioned against its trigger. The trigger opens it on hover and on focus, and Escape dismisses it. On a device with no hover the card opens on a tap and closes on an outside tap.

ui-hover-card

AttributeTypeDefault
openbooleanfalse
open-delaynumber (ms)700
close-delaynumber (ms)300

open is reflected, so CSS and scripts can observe it. The element dispatches no events, and has .show() and .hide() methods.

ui-hover-card-trigger

Wraps the link or button the card describes. It carries aria-haspopup, aria-expanded and aria-controls.

ui-hover-card-content

AttributeTypeDefault
side"top" | "right" | "bottom" | "left""bottom"
align"start" | "center" | "end""center"
side-offsetnumber4
align-offsetnumber0

The panel is a role="dialog" and always has a name: an aria-label or aria-labelledby you put on it, else a data-slot="hover-card-title" node or heading inside it, else the trigger's text.