Skip to content
v0.2.10

HoverCard

A focusable preview that opens on hover, keyboard focus or explicit activation.

Preview

Use HoverCard

HoverCard is a named export of @flood-md/react. Connect the package once, then import what you use.

First time here? Connect Flood
Example import style
hover-card.tsxTSX
"use client";

import { FloodRoot, HoverCard, Button, Text, Link } from "@flood-md/react";
import "@flood-md/react/styles.css";

export function Example() {
  return (
    <FloodRoot>
      <HoverCard title="Alex Morgan" trigger={props => <Button {...props} variant="subtle">Alex Morgan</Button>}>
        <Text as="p" size="compact">Designer at Flood.</Text>
        <Link href="https://github.com/tillwithered">View profile</Link>
      </HoverCard>
    </FloodRoot>
  );
}

Design notes

  • Interactive content belongs to a named dialog preview, not a tooltip.
  • Click pins the preview; keyboard and touch users can activate the trigger.

API reference

PropValuesDefault
titleReactNodeRequired
trigger(props: OverlayTriggerProps) => ReactNodeRequired
childrenReactNodeRequired
side"top" | "bottom" | "left" | "right"—
align"start" | "center" | "end"—
openboolean—
defaultOpenboolean—
onOpenChange(open: boolean) => void—
openDelaynumber—
closeDelaynumber—
disabledboolean—
closeLabelstring—
Native HTML propsOmit<HTMLAttributes<HTMLDivElement>, "children" | "title" | "role">Forwarded
View TypeScript source