@react-fabric/core 1.0.0-beta.5 → 1.0.0-beta.52

package/dist/types/components/animations/Animations.d.ts

@@ -4,20 +4,99 @@ export interface AnimationProps extends CssProp, AriaProps {
     /**
      * icon color
      */
-    color?: ColorType | PaletteType;
+    color?: ColorType | PaletteType | string;
     /**
      * icon mark color
      */
-    strokeColor?: ColorType | PaletteType;
+    strokeColor?: ColorType | PaletteType | string;
 }
+/**
+ * A component that displays an animated indicator with a customizable icon type and colors.
+ * It can be used to indicate various states such as success, error, or information.
+ * The component supports different icon types like check, cross, question, and exclamation.
+ * It also allows customization of the icon color and stroke color.
+ *
+ * @param {AnimationProps} props - The properties for the AnimationIndicator component.
+ * @returns {JSX.Element} The rendered AnimationIndicator component.
+ *
+ * @example
+ * ```jsx
+ * <AnimationIndicator
+ *   type="check"
+ *   color="primary-500"
+ *   strokeColor="primary-700"
+ *   className="my-custom-class"
+ *   aria-label="Loading"
+ * />
+ * ```
+ *
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/story/core-components-animations--docs} for more details.
+ */
 export declare const AnimationIndicator: ({ className, color, strokeColor, type, ...aria }: AnimationProps) => import("react/jsx-runtime").JSX.Element;
+/**
+ * A component that displays an animated bars loader.
+ * It can be customized with color and size properties.
+ * This component is typically used to indicate loading states in the UI.
+ *
+ * @param {Object} props - The properties for the AnimationBars component.
+ * @param {ColorType | PaletteType | string} [props.color="tint-500"] - The color of the bars.
+ * @param {number | string} [props.size="2rem"] - The size of the bars.
+ * @returns {JSX.Element} The rendered AnimationBars component.
+ *
+ * @example
+ * ```jsx
+ * <AnimationBars color="primary-500" size="3rem" />
+ * ```
+ *
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/story/core-components-animations--docs} for more details.
+ */
 export declare const AnimationBars: ({ color, size, }: {
-    color?: ColorType | string;
+    color?: ColorType | PaletteType | string;
     size?: number | string;
 }) => import("react/jsx-runtime").JSX.Element;
+/**
+ * A component that displays a spinner animation.
+ * It can be customized with color and size properties.
+ * This component is typically used to indicate loading states in the UI.
+ *
+ * @param {Object} props - The properties for the AnimationSpinner component.
+ * @param {ColorType | PaletteType | string} [props.color="tint-700"] - The color of the spinner.
+ * @param {number | string} [props.size="2rem"] - The size of the spinner.
+ * @returns {JSX.Element} The rendered AnimationSpinner component.
+ *
+ * @example
+ * ```jsx
+ * <AnimationSpinner color="primary-500" size="3rem" />
+ * ```
+ *
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/story/core-components-animations--docs} for more details.
+ */
 export declare const AnimationSpinner: ({ color, size, }: {
-    color?: ColorType | string;
+    color?: ColorType | PaletteType | string;
     size?: number | string;
 }) => import("react/jsx-runtime").JSX.Element;
+/**
+ * A component that displays a skeleton loader with a placeholder for content.
+ * It can be customized with color and size properties.
+ * This component is typically used to indicate loading states in the cards, panels and virtual lists,
+ * providing a visual placeholder for content that is being loaded.
+ *
+ * @param {CssProp} props - The properties for the Skeleton component.
+ * @returns {JSX.Element} The rendered Skeleton component.
+ *
+ * @example
+ * ```jsx
+ * <Skeleton className="my-skeleton" />
+ * * // Renders a skeleton loader with a placeholder for content.
+ * ```
+ *
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/story/core-components-animations--docs} for more details.
+ */
+export declare const Skeleton: ({ className, ...rest }: CssProp) => import("react/jsx-runtime").JSX.Element;
+/**
+ * A component that displays a loading animation with a top border.
+ * It is typically used to indicate that content is being loaded in pages and page sections.
+ *
+ * @returns {JSX.Element} The rendered Loading component.
+ */
 export declare const Loading: () => import("react/jsx-runtime").JSX.Element;
-export declare const Skeleton: () => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/avatar/Avatar.d.ts

@@ -1,5 +1,4 @@
-/// <reference types="react" />
-import { type AriaProps, type ColorType, type CssProp, type RefProp, type SizeType, type TestProps } from "../../types";
+import { type PaletteType, type AriaProps, type ColorType, type CssProp, type RefProp, type SizeType, type TestProps } from "../../types";
 export interface AvatarProps extends CssProp, AriaProps, TestProps, RefProp {
     /**
      * avatar name for generated fallback
@@ -20,11 +19,11 @@ export interface AvatarProps extends CssProp, AriaProps, TestProps, RefProp {
     /**
      * background color (CSS color / tailwind color)
      */
-    bg?: ColorType | string;
+    bg?: ColorType | PaletteType | string;
     /**
      * icon color (CSS color / tailwind color)
      */
-    color?: ColorType | string;
+    color?: ColorType | PaletteType | string;
     /**
      * icon size
      */
@@ -43,6 +42,31 @@ export interface AvatarProps extends CssProp, AriaProps, TestProps, RefProp {
     onClick?: React.MouseEventHandler;
 }
 /**
- * An avatar is a graphical representation of a user's identity.
+ * A component that displays an avatar image or a fallback icon with customizable styles and properties.
+ * It supports various avatar types, including text-based avatars, and allows for customization of background color, icon color, size, and rounded corners.
+ * This component is useful for displaying user avatars in applications, providing a visual representation of users or entities.
+ * It can also handle cases where the avatar image fails to load by displaying a fallback icon or text.
+ * It uses the Boring Avatars library for generating fallback avatars based on the user's name.
+ *
+ * @param {AvatarProps} props - The properties for the Avatar component.
+ * @returns {JSX.Element} The rendered Avatar component.
+ *
+ * @example
+ * ```jsx
+ * <Avatar
+ *   name="John Doe"
+ *   avatar="https://example.com/avatar.jpg"
+ *   fallbackIcon="fas fa-user"
+ *   bg="bg-blue-500"
+ *   color="text-white"
+ *   size="md"
+ *   rounded
+ *   variant="beam"
+ *   onClick={() => console.log("Avatar clicked")}
+ * />
+ * ```
+ *
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/story/core-components-avatar--docs} for more details.
+ * @see {@link https://boringavatars.com/} for more information on Boring Avatars.
  */
 export declare const Avatar: ({ ref, name, avatar, fallbackIcon, bg, color, size, rounded, variant, className, viewBox, onClick, ...aria }: AvatarProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/avatar/AvatarGroup.d.ts

@@ -18,7 +18,25 @@ export interface AvatarGroupProps extends CssProp, RefProp, AriaProps {
     totalCount?: number;
 }
 /**
- * Group multiple avatars together
+ * A component that groups multiple avatars together, displaying a count of additional avatars if the total exceeds the visible ones.
+ * It allows customization of size, rounding, and additional aria attributes.
+ * This component is useful for displaying a collection of user avatars in a compact format, such as in a chat application or user list.
+ * It automatically calculates the number of additional avatars based on the `totalCount` prop and the number of children provided.
+ *
+ * @param {AvatarGroupProps} props - The properties for the AvatarGroup component.
+ * @returns {JSX.Element} The rendered AvatarGroup component.
+ *
+ * @example
+ * ```jsx
+ * <AvatarGroup totalCount={5} size="md" className="my-avatar-group">
+ *   <Avatar name="John Doe" avatar="https://example.com/avatar1.jpg" />
+ *   <Avatar name="Jane Smith" avatar="https://example.com/avatar2.jpg" />
+ *   <Avatar name="Alice Johnson" avatar="https://example.com/avatar3.jpg" />
+ *   <Avatar name="Bob Brown" avatar="https://example.com/avatar4.jpg" />
+ * </AvatarGroup>
+ * ```
+ *
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/docs/core-components-avatar--docs} for more details.
  */
 export declare const AvatarGroup: ({ ref, children, className, totalCount, rounded, size, ...aria }: AvatarGroupProps) => import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/types/components/badge/Badge.d.ts

@@ -4,6 +4,10 @@ export interface BadgeProps extends CssProp, RefProp, IconProps, Partial<ChildPr
      * make wrapper a block element
      */
     block?: boolean;
+    /**
+     * inline badge
+     */
+    inline?: boolean;
     /**
      * badge value
      */
@@ -21,5 +25,30 @@ export interface BadgeProps extends CssProp, RefProp, IconProps, Partial<ChildPr
      */
     placement?: "top-start" | "top-end" | "bottom-start" | "bottom-end" | "top" | "bottom" | "start" | "end";
 }
+/**
+ * Utility function to get badge properties from a badge value or object.
+ * It checks if the badge is an object and returns its properties,
+ *
+ * @param {string | number | BadgeType} badge - The badge value or object.
+ * @returns {AnyObject} An object containing badge properties.
+ */
 export declare const getBadgeProps: (badge?: string | number | BadgeType) => AnyObject;
-export declare const Badge: ({ ref, className, value, max, ping, block, placement, children, forButton, icon, iconBg, iconColor, rtlFlip, ...rest }: BadgeProps) => import("react/jsx-runtime").JSX.Element;
+/**
+ * A component that displays a badge with a value, icon, and optional ping animation.
+ * It can be used to indicate notifications, messages, or other important information.
+ * It supports various placements, inline or block display, and custom styling.
+ * It can also wrap children elements, allowing for flexible usage in buttons or other components.
+ *
+ * @param {BadgeProps} props - The properties for the Badge component.
+ * @returns {JSX.Element} The rendered Badge component.
+ *
+ * @example
+ * ```jsx
+ * <Badge value={5} max={10} ping>
+ *   <button>Notifications</button>
+ * </Badge>
+ * ```
+ *
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/docs/core-components-badge--docs} for more details.
+ */
+export declare const Badge: ({ ref, className, value, max, ping, block, inline, placement, children, forButton, icon, iconBg, iconColor, rtlFlip, ...rest }: BadgeProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/breadcrumbs/Breadcrumbs.d.ts

@@ -1,6 +1,6 @@
 import { type AriaProps, type ChildrenProp, type CssProp } from "../../types";
-import { Link } from "../../typography/Link";
-export interface BreadcrumbProps extends CssProp, AriaProps, ChildrenProp<typeof Link> {
+import { Anchor } from "../../typography/Anchor";
+export interface BreadcrumbProps extends CssProp, AriaProps, ChildrenProp<typeof Anchor> {
     /**
      * breadcrumb styling
      */
@@ -14,4 +14,33 @@ export interface BreadcrumbProps extends CssProp, AriaProps, ChildrenProp<typeof
      */
     color?: "primary" | "accent";
 }
+/**
+ * A navigation component that displays the current page's location within a hierarchy and allows users to navigate back to previous pages.
+ * It supports different styles, separators, and colors, and can handle a variable number of breadcrumb links.
+ * This component is useful for enhancing user navigation experience in applications with multiple levels of content hierarchy.
+ * It automatically manages the display of overflow items when there are too many links to fit in the available space, providing a dropdown for additional links.
+ *
+ * @param {BreadcrumbProps} props - The properties for the Breadcrumbs component.
+ * @returns {JSX.Element} The rendered Breadcrumbs component.
+ *
+ * @example
+ * ```jsx
+ * <Breadcrumbs
+ *   variant="classic"
+ *   separator=">"
+ *   color="primary"
+ *   className="my-custom-class"
+ *   aria-label="Breadcrumbs"
+ * >
+ *   <Anchor href="/">Home</Anchor>
+ *   <Anchor href="/products">Products</Anchor>
+ *   <Anchor href="/products/shoes">Shoes</Anchor>
+ *   <Anchor href="/products/shoes/sneakers">Sneakers</Anchor>
+ *   <Anchor href="/products/shoes/sneakers/nike">Nike</Anchor>
+ *   <Anchor href="/products/shoes/sneakers/nike/airmax">Air Max</Anchor>
+ * </Breadcrumbs>
+ * ```
+ *
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/docs/core-components-breadcrumbs--docs} for more details.
+ */
 export declare const Breadcrumbs: ({ variant, className, separator, children, color, ...aria }: BreadcrumbProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/button/Button.d.ts

@@ -1,5 +1,5 @@
 import { type MouseEventHandler, type WheelEventHandler } from "react";
-import { type AriaProps, type BadgeType, type CallbackReturn, type ColorType, type CssProp, type IconProps, type PolymorphicProps, type RefProp, type SizeType, type TestProps } from "../../types";
+import { type ColorState, type AriaProps, type BadgeType, type CallbackReturn, type CssProp, type IconProps, type PolymorphicProps, type RefProp, type SizeType, type TestProps } from "../../types";
 export interface BaseProps extends CssProp, AriaProps, IconProps, RefProp, TestProps {
     /**
      * primary icon alignment
@@ -16,7 +16,7 @@ export interface BaseProps extends CssProp, AriaProps, IconProps, RefProp, TestP
     /**
      * button color
      */
-    color?: ColorType;
+    color?: ColorState;
     /**
      * button type
      */
@@ -24,7 +24,7 @@ export interface BaseProps extends CssProp, AriaProps, IconProps, RefProp, TestP
     /**
      * button styling
      */
-    variant?: "outline" | "solid" | "link";
+    variant?: "outline" | "soft" | "solid" | "link";
     /**
      * active state with click disabled
      */
@@ -82,14 +82,37 @@ export interface BaseProps extends CssProp, AriaProps, IconProps, RefProp, TestP
     onMouseLeave?: MouseEventHandler;
     onWheel?: WheelEventHandler;
 }
-export type ButtonProps = {
+type ButtonTypeProps = {
     children: string | React.ReactElement;
     "aria-label"?: string;
 } | {
     children?: never;
     "aria-label": string;
 };
+export type ButtonProps<Tag extends React.ElementType = "button"> = BaseProps & ButtonTypeProps & PolymorphicProps<Tag>;
 /**
- * Clickable action button
+ * A versatile button component that supports various styles, icons, and actions.
+ * It can be used as a primary action button, with options for loading states, action messages, and more.
+ * It supports polymorphic rendering, allowing it to be used as different HTML elements (e.g., button, a, div).
+ * It also includes features like after action tooltips, badges, and keyboard shortcuts.
+ *
+ * @param {ButtonProps} props - The properties for the Button component.
+ * @returns {JSX.Element} The rendered Button component.
+ *
+ * @example
+ * ```jsx
+ * <Button
+ *   color="primary"
+ *   size="md"
+ *   variant="solid"
+ *   icon="check"
+ *   onClick={() => console.log("Button clicked!")}
+ * >
+ *   Click Me
+ * </Button>
+ * ```
+ *
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/docs/core-components-button--docs} for more details.
  */
-export declare const Button: <Tag extends import("react").ElementType<any, keyof import("react").JSX.IntrinsicElements> = "button">({ as, ref, children, className, active, color, icon, iconBg, iconColor, iconAlign, altIcon, rtlFlip, rounded, size, disabled, loading, variant, badge, fullWidth, spinOnHover, onClick, actionMessage, stopPropagation, type, hotKey, showActionDone, showActionDoneEvent, tabIndex, "data-ref": dataRef, ...aria }: BaseProps & ButtonProps & PolymorphicProps<Tag>) => import("react/jsx-runtime").JSX.Element;
+export declare const Button: <Tag extends React.ElementType = "button">({ as, ref, children, className, active, color, icon, iconBg, iconColor, iconAlign, altIcon, rtlFlip, rounded, size, disabled, loading, variant, badge, fullWidth, spinOnHover, onClick, actionMessage, stopPropagation, type, hotKey, showActionDone, showActionDoneEvent, tabIndex, "data-ref": dataRef, ...aria }: ButtonProps<Tag>) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/types/components/button/ButtonGroup.d.ts

@@ -1,5 +1,4 @@
-/// <reference types="react" />
-import { type AriaProps, type ChildrenProp, type ColorType, type CssProp, type RefProp, type SizeType, type TestProps } from "../../types";
+import { type AriaProps, type ChildrenProp, type ColorState, type CssProp, type RefProp, type SizeType, type TestProps } from "../../types";
 import { type Button } from "./Button";
 export interface ButtonGroupProps extends CssProp, AriaProps, TestProps, RefProp<HTMLDivElement>, ChildrenProp<React.ReactElement<typeof Button>> {
     /**
@@ -17,7 +16,7 @@ export interface ButtonGroupProps extends CssProp, AriaProps, TestProps, RefProp
     /**
      * button color
      */
-    color?: ColorType;
+    color?: ColorState;
     /**
      * full rounded edges
      */
@@ -31,4 +30,30 @@ export interface ButtonGroupProps extends CssProp, AriaProps, TestProps, RefProp
      */
     fullWidth?: boolean;
 }
+/**
+ * A component that groups buttons together, allowing for consistent styling and behavior across multiple buttons.
+ * It supports vertical orientation, various button styles, and can handle properties like size, color, and disabled state.
+ * This component is useful for creating button groups that maintain a uniform appearance and functionality,
+ * such as toolbars, action groups, or navigation buttons.
+ *
+ * @param {ButtonGroupProps} props - The properties for the ButtonGroup component.
+ * @returns {JSX.Element} The rendered ButtonGroup component.
+ *
+ * @example
+ * ```jsx
+ * <ButtonGroup
+ *   variant="solid"
+ *   color="primary"
+ *   className="my-custom-class"
+ *   aria-label="Button Group"
+ *   vertical
+ * >
+ *   <Button>Button 1</Button>
+ *   <Button>Button 2</Button>
+ *   <Button>Button 3</Button>
+ * </ButtonGroup>
+ * ```
+ *
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/docs/core-components-buttongroup--docs} for more details.
+ */
 export declare const ButtonGroup: ({ vertical, className, children, variant, rounded, disabled, fullWidth, color, size, ...aria }: ButtonGroupProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/button/ConfirmButton.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="react" />
+import { type Placement } from "@floating-ui/react";
 import { type CallbackReturn, type PolymorphicProps, type RefProp } from "../../types";
 import { type BaseProps, type ButtonProps } from "./Button";
 interface ExtendedProps extends Omit<BaseProps, "onClick">, RefProp {
@@ -14,6 +14,10 @@ interface ExtendedProps extends Omit<BaseProps, "onClick">, RefProp {
      * ok label
      */
     cancelLabel?: string;
+    /**
+     * dropdown placement
+     */
+    placement?: Placement;
     /**
      * click handler, return Promise to autoset loading state
      */
@@ -21,7 +25,28 @@ interface ExtendedProps extends Omit<BaseProps, "onClick">, RefProp {
 }
 export type ConfirmButtonProps = ExtendedProps & ButtonProps;
 /**
- * Button with confirmation dropdown
+ * A button that shows a confirmation dialog when clicked, allowing the user to confirm or cancel an action.
+ * It supports custom messages, labels, and loading states.
+ * This component is useful for actions that require user confirmation, such as deleting items or submitting forms.
+ * It uses the Floating UI library to manage the positioning of the confirmation dialog, ensuring it appears correctly relative to the button.
+ * It also supports custom placement of the dialog, and can display an action message when the action is completed.
+ *
+ * @param {ConfirmButtonProps} props - The properties for the ConfirmButton component.
+ * @returns {JSX.Element} The rendered ConfirmButton component.
+ *
+ * @example
+ * ```jsx
+ * <ConfirmButton
+ *   message="Are you sure you want to delete this item?"
+ *   onClick={(confirmed) => {
+ *     if (confirmed) {
+ *       // Perform action
+ *     }
+ *   }}
+ * />
+ * ```
+ *
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/docs/core-components-confirmbutton--docs} for more details.
  */
-export declare const ConfirmButton: <Tag extends import("react").ElementType<any, keyof import("react").JSX.IntrinsicElements> = "button">({ ref, message, color, okLabel, cancelLabel, onClick, loading, actionMessage, showActionDone, showActionDoneEvent, ...props }: ConfirmButtonProps & PolymorphicProps<Tag>) => import("react/jsx-runtime").JSX.Element;
+export declare const ConfirmButton: <Tag extends React.ElementType = "button">({ ref, message, color, okLabel, cancelLabel, onClick, loading, placement, actionMessage, showActionDone, showActionDoneEvent, ...props }: ConfirmButtonProps & PolymorphicProps<Tag>) => import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/types/components/button/ToggleButtonGroup.d.ts

@@ -1,9 +1,6 @@
-/// <reference types="react" />
 import { type AriaProps, type ChildrenProp, type ColorType, type CssProp, type SizeType } from "../../types";
 import { type ButtonProps } from "./Button";
-interface BaseProps extends CssProp, AriaProps, ChildrenProp<React.ReactElement<ButtonProps & {
-    value: string;
-}>> {
+interface BaseProps extends CssProp, AriaProps {
     /**
      * vertical orientation
      */
@@ -33,24 +30,55 @@ interface BaseProps extends CssProp, AriaProps, ChildrenProp<React.ReactElement<
      */
     fullWidth?: boolean;
 }
-export type ToggleButtonGroupProps = BaseProps & ({
+export type ToggleButtonGroupValueProps<T> = {
     /**
      *
      */
-    value: string;
+    value: T;
     /**
      * change handler
      */
-    onChange?: (value: string) => void;
+    onChange?: (value: T | null) => void;
 } | {
     /**
      *
      */
-    value: string[];
+    value: T[];
     /**
      * change handler
      */
-    onChange?: (value: string[]) => void;
-});
-export declare const ToggleButtonGroup: ({ vertical, className, children, variant, rounded, disabled, fullWidth, color, size, value, onChange, ...aria }: ToggleButtonGroupProps) => import("react/jsx-runtime").JSX.Element;
+    onChange?: (value: T[] | null) => void;
+};
+export type ToggleButtonGroupProps<T> = BaseProps & ChildrenProp<React.ReactElement<ButtonProps & {
+    value: T;
+}>> & ToggleButtonGroupValueProps<T>;
+/**
+ * A component that groups toggle buttons together, allowing for consistent styling and behavior across multiple toggle buttons.
+ * It supports vertical orientation, various button styles, and can handle properties like size, color, and disabled state.
+ * This component is useful for creating toggle button groups that maintain a uniform appearance and functionality,
+ * such as toggle switches, selection groups, or multi-select options.
+ *
+ * @param {ToggleButtonGroupProps} props - The properties for the ToggleButtonGroup component.
+ * @returns {JSX.Element} The rendered ToggleButtonGroup component.
+ *
+ * @example
+ * ```jsx
+ * <ToggleButtonGroup
+ *   value={selectedValues}
+ *   onChange={(newValues) => setSelectedValues(newValues)}
+ *   variant="outline"
+ *   color="primary"
+ *   size="md"
+ *   rounded
+ *   fullWidth
+ * >
+ *   <Button value="option1">Option 1</Button>
+ *   <Button value="option2">Option 2</Button>
+ *   <Button value="option3">Option 3</Button>
+ * </ToggleButtonGroup>
+ * ```
+ *
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/docs/core-components-togglebuttongroup--docs} for more details.
+ */
+export declare const ToggleButtonGroup: <T extends AnyObject = string>({ vertical, className, children, variant, rounded, disabled, fullWidth, color, size, value, onChange, ...aria }: ToggleButtonGroupProps<T>) => import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/types/components/callout/Callout.d.ts

@@ -1,13 +1,13 @@
-import { type AriaProps, type ChildrenProp, type ColorType, type CssProp, type PaletteType, type TestProps } from "../../types";
+import { type AriaProps, type ChildrenProp, type ColorState, type CssProp, type TestProps } from "../../types";
 export interface CalloutProps extends AriaProps, ChildrenProp, CssProp, TestProps {
     /**
      * callout color
      */
-    color?: ColorType | PaletteType;
+    color?: ColorState | "none";
     /**
      * legend title
      */
-    legend?: string;
+    legend?: string | React.ReactElement;
     /**
      * callout icon
      */
@@ -25,4 +25,30 @@ export interface CalloutProps extends AriaProps, ChildrenProp, CssProp, TestProp
      */
     onClose?: () => void;
 }
+/**
+ * A component that displays a callout box with an optional title, icon, and legend.
+ * It can be used to highlight important information, warnings, or notices.
+ * The callout can be styled with different colors and border styles, and it supports a close action.
+ * This component is useful for drawing attention to specific content within a page or application,
+ * such as alerts, notifications, or important messages.
+ *
+ * @param {CalloutProps} props - The properties for the Callout component.
+ * @returns {JSX.Element} The rendered Callout component.
+ *
+ * @example
+ * ```jsx
+ * <Callout
+ *   color="primary"
+ *   legend="Important Notice"
+ *   title="Attention Required"
+ *   icon="info"
+ *   onClose={() => console.log("Callout closed")}
+ * >
+ *   This is an important message that requires your attention.
+ * </Callout>
+ * // Renders a callout box with a primary color, an icon, a title, and a close button.
+ * ```
+ *
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/story/core-components-callout--docs} for more details.
+ */
 export declare const Callout: ({ children, color, legend, title, icon, border, onClose, className, ...aria }: CalloutProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/card/Card.d.ts

@@ -1,8 +1,8 @@
-import { type MouseEventHandler } from "react";
+import { type DragEvent, type MouseEventHandler } from "react";
 import { type ContentProps } from "../../core/content/Content";
 import { type HeadFootProps } from "../../core/headfoot/HeadFoot";
-import { type AriaProps, type ChildrenProp, type CssProp, type TestProps } from "../../types";
-export interface CardProps extends CssProp, AriaProps, TestProps, ChildrenProp<React.ReactElement<HeadFootProps | ContentProps>> {
+import { type AriaProps, type ChildrenProp, type CssProp, type RefProp, type TestProps } from "../../types";
+export interface CardProps extends CssProp, AriaProps, TestProps, RefProp<HTMLDivElement>, ChildrenProp<React.ReactElement<HeadFootProps | ContentProps>> {
     /**
      * apply flex fill styling
      */
@@ -11,6 +11,10 @@ export interface CardProps extends CssProp, AriaProps, TestProps, ChildrenProp<R
      * click handler
      */
     onClick?: MouseEventHandler;
+    /**
+     * drag start handler
+     */
+    onDragStart?: (event: DragEvent, dragKey: string, dragData?: KeyValue) => void;
     /**
      * body css classname(s)
      */
@@ -36,4 +40,38 @@ export interface CardProps extends CssProp, AriaProps, TestProps, ChildrenProp<R
      */
     dragData?: KeyValue;
 }
-export declare const Card: ({ children, className, bodyClassName, selected, selectedRibbon, onClick, flex, draggable, dragKey, dragData, ...aria }: CardProps) => import("react/jsx-runtime").JSX.Element;
+/**
+ * A component that displays a card with a header, body, and footer. It can be used to display content in a structured format.
+ * It supports various features such as click handling, drag-and-drop functionality, and customizable styles.
+ * The Card component is designed to be flexible and can be used in various contexts, such as displaying user profiles, product information, or any other content that benefits from a card layout.
+ * The component accepts children that can include a Header, body content, and a Footer.
+ * It also supports additional properties for styling, accessibility, and interaction.
+ * It can be styled with custom CSS classes and supports features like selection indication and drag-and-drop functionality.
+ *
+ * @param {CardProps} props - The properties for the Card component.
+ * @returns {JSX.Element} The rendered Card component.
+ *
+ * @example
+ * ```jsx
+ * <Card
+ *   className="my-custom-class"
+ *   bodyClassName="my-body-class"
+ *   selected={true}
+ *   selectedRibbon={true}
+ *   onClick={() => console.log("Card clicked")}
+ *   onDragStart={(event, key, data) => console.log("Drag started", key, data)}
+ *   flex={true}
+ *   draggable={true}
+ *   dragKey="my-drag-key"
+ *   dragData={{ id: 1, name: "Card Data" }}
+ *   aria-label="My Card"
+ * >
+ *   <Header>Card Header</Header>
+ *   <div>Card Body Content</div>
+ *   <Footer>Card Footer</Footer>
+ * </Card>
+ * ```
+ *
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/docs/core-components-card--docs} for more details.
+ */
+export declare const Card: ({ children, className, bodyClassName, selected, selectedRibbon, onClick, onDragStart, flex, draggable, dragKey, dragData, ref, ...aria }: CardProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/card/CardCover.d.ts

@@ -13,4 +13,29 @@ export interface CardCoverProps extends CssProp, AriaProps, ChildrenProp {
      */
     justify?: "start" | "center" | "end";
 }
+/**
+ * A cover component for cards that can contain media and content.
+ * It allows for flexible layout options and supports different color schemes.
+ * It can be used to create visually appealing card layouts with media content.
+ *
+ * @param {CardCoverProps} props - The properties for the CardCover component.
+ * @returns {JSX.Element} The rendered CardCover component.
+ *
+ * @example
+ * ```jsx
+ * <CardCover
+ *   height={200}
+ *   colorScheme="light"
+ *   justify="center"
+ *   className="my-custom-class"
+ *   aria-label="Card Cover"
+ * >
+ *   <Image src="image.jpg" alt="Card Image" />
+ *   <div>Card Content</div>
+ * </CardCover>
+ * // Renders a card cover with a height of 200px, light color scheme, centered content, and a custom class name.
+ * ```
+ *
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/story/core-components-card--docs} for more details.
+ */
 export declare const CardCover: ({ className, children, height, justify, colorScheme, ...aria }: CardCoverProps) => import("react/jsx-runtime").JSX.Element;