@arolariu/components
Version:
🎨 70+ beautiful, accessible React components built on Base UI. TypeScript-first, CSS Modules styling, tree-shakeable, SSR-ready. Perfect for modern web apps, design systems & rapid prototyping. Zero config, maximum flexibility! ⚡
88 lines • 3.05 kB
TypeScript
import { PreviewCard as BasePreviewCard } from "@base-ui/react/preview-card";
import * as React from "react";
interface HoverCardProps extends React.ComponentPropsWithRef<typeof BasePreviewCard.Root> {
}
interface HoverCardTriggerProps extends Omit<React.ComponentPropsWithRef<typeof BasePreviewCard.Trigger>, "className"> {
/**
* Applies additional CSS classes to the component root element.
* @default undefined
*/
className?: string;
}
interface HoverCardContentProps extends Omit<React.ComponentPropsWithRef<typeof BasePreviewCard.Positioner>, "className"> {
/**
* Applies additional CSS classes to the component root element.
* @default undefined
*/
className?: string;
/**
* Offsets the floating content from its anchor in pixels.
* @default 4
*/
sideOffset?: number;
}
/**
* Coordinates hover card state and accessibility behavior.
*
* @remarks
* - Delegates structure and state to the underlying Base UI primitive
* - Built on {@link https://base-ui.com/react/components/preview-card | Base UI Preview Card}
* - Preserves the underlying primitive API for advanced composition
*
* @example
* ```tsx
* <HoverCard>Content</HoverCard>
* ```
*
* @see {@link https://base-ui.com/react/components/preview-card | Base UI Documentation}
*/
declare function HoverCard(props: Readonly<HoverCard.Props>): React.ReactElement;
declare namespace HoverCard {
var displayName: string;
}
/**
* Renders the hover card trigger.
*
* @remarks
* - Renders a `<a>` element by default
* - Built on {@link https://base-ui.com/react/components/preview-card | Base UI Preview Card}
* - Supports the `render` prop for element composition
*
* @example
* ```tsx
* <HoverCardTrigger>Content</HoverCardTrigger>
* ```
*
* @see {@link https://base-ui.com/react/components/preview-card | Base UI Documentation}
*/
declare const HoverCardTrigger: React.ForwardRefExoticComponent<Omit<HoverCardTriggerProps, "ref"> & React.RefAttributes<HTMLAnchorElement>>;
/**
* Renders the hover card content.
*
* @remarks
* - Renders a `<div>` element by default
* - Built on {@link https://base-ui.com/react/components/preview-card | Base UI Preview Card}
* - Supports the `render` prop for element composition
*
* @example
* ```tsx
* <HoverCardContent>Content</HoverCardContent>
* ```
*
* @see {@link https://base-ui.com/react/components/preview-card | Base UI Documentation}
*/
declare const HoverCardContent: React.ForwardRefExoticComponent<Omit<HoverCardContentProps, "ref"> & React.RefAttributes<HTMLDivElement>>;
declare namespace HoverCard {
type Props = HoverCardProps;
type State = BasePreviewCard.Root.State;
}
declare namespace HoverCardTrigger {
type Props = HoverCardTriggerProps;
type State = BasePreviewCard.Trigger.State;
}
declare namespace HoverCardContent {
type Props = HoverCardContentProps;
type State = BasePreviewCard.Popup.State;
}
export { HoverCard, HoverCardContent, HoverCardTrigger };
//# sourceMappingURL=hover-card.d.ts.map