beez-ui 2.7.0 → 3.0.0

package/dist/components/card.d.ts

@@ -1,27 +1,38 @@
+import type { ComponentProps, ReactNode } from "react";
+import type { CardHeadingLevel } from "../constants/card.js";
+export type { CardHeadingLevel };
+export type CardProps = Omit<ComponentProps<"article">, "title"> & {
+    /** Card heading. Without it the card renders only its surface and children. With `details` it opens the quick look. */
+    title?: ReactNode;
+    /** Supporting line under the title. */
+    description?: ReactNode;
+    /** Image or visual at the top. Zooms slightly on hover. */
+    media?: ReactNode;
+    /** Trailing control of the byline row, such as a button. */
+    action?: ReactNode;
+    /** Small leading visual of the byline, such as the owner's avatar. */
+    avatar?: ReactNode;
+    /** Who the card belongs to, shown in the byline. */
+    meta?: ReactNode;
+    /** Short status under the meta, such as "Actualizada hace 2 horas". Changes roll in word by word and are announced politely. */
+    status?: string;
+    /** Quick look content. With a `title`, the card opens into a larger dialog that grows out of it. */
+    details?: ReactNode;
+    /** Controlled quick look state. */
+    open?: boolean;
+    /** Initial quick look state when uncontrolled. */
+    defaultOpen?: boolean;
+    /** Called when the quick look opens or closes. */
+    onOpenChange?: (open: boolean) => void;
+    /** Content rendered after the body and byline, such as a row of actions. */
+    footer?: ReactNode;
+    /** Heading level of the title. */
+    headingLevel?: CardHeadingLevel;
+};
 /**
- * Arc's Card (https://uiarc.dev, MIT License, see THIRD_PARTY_NOTICES.md): a contained group of related content on
- * Arc's surface, panel radius and spacing. A card holding a link or button floats a little on fine-pointer hover,
- * and `CardMedia` drifts its photo in slowly while the card is pointed at. The compound shadcn structure is kept;
- * Arc's quick look is not part of it.
+ * A content card with optional media, byline, action and footer that can grow into a quick look dialog.
+ * @param props - Arc's card content and quick look state, the heading level, a footer and native article attributes.
+ * @returns The card article, wrapped in its quick look dialog when `details` is set.
  */
-import * as React from "react";
-/**
- * Card surface. The outline is a 1px ring in the border token, so the hover shadow can stack on it, and isolation
- * keeps the rounded clip on media while the card lifts (Safari drops it otherwise).
- */
-declare function Card({ className, size, ...props }: React.ComponentProps<"div"> & {
-    size?: "default" | "sm";
-}): React.JSX.Element;
-/**
- * Arc's card media: a muted frame for a photo or illustration that zooms in slowly while the card is pointed at
- * and eases back a little faster. Place it first to sit flush with the top edge.
- */
-declare function CardMedia({ className, children, ...props }: React.ComponentProps<"div">): React.JSX.Element;
-declare function CardHeader({ className, ...props }: React.ComponentProps<"div">): React.JSX.Element;
-declare function CardTitle({ className, ...props }: React.ComponentProps<"div">): React.JSX.Element;
-declare function CardDescription({ className, ...props }: React.ComponentProps<"div">): React.JSX.Element;
-declare function CardAction({ className, ...props }: React.ComponentProps<"div">): React.JSX.Element;
-declare function CardContent({ className, ...props }: React.ComponentProps<"div">): React.JSX.Element;
-/** Arc's footer row: a byline or meta on the start side and actions on the end, without a tinted band. */
-declare function CardFooter({ className, ...props }: React.ComponentProps<"div">): React.JSX.Element;
-export { Card, CardHeader, CardFooter, CardTitle, CardAction, CardDescription, CardContent, CardMedia, };
+declare function Card({ title, description, media, action, avatar, meta, status, details, open: openProp, defaultOpen, onOpenChange, footer, headingLevel, children, className, style, ref, ...props }: CardProps): import("react").JSX.Element;
+export { Card };