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

package/dist/esm/components/animations/Animations.js

@@ -5,14 +5,36 @@ import _objectWithoutProperties from '@babel/runtime/helpers/objectWithoutProper
 import classNames from 'classnames';
 import { useMemo } from 'react';
 import { useMemoDebugger } from '../../hooks/useEffectDebugger.js';
-import { getColor, getColorClass } from '../../utils/getColor.js';
-import '@react-fabric/utilities';
-import classes from './Animations.module.css';
 import { jsxs, jsx } from 'react/jsx-runtime';
+import { getColor } from '../../utils/getColor.js';
+import '@react-fabric/utilities';
 
-var _excluded = ["className", "color", "strokeColor", "type"];
+var _excluded = ["className", "color", "strokeColor", "type"],
+  _excluded2 = ["className"];
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+/**
+ * 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.
+ */
 var AnimationIndicator = function AnimationIndicator(_ref) {
   var className = _ref.className,
     color = _ref.color,
@@ -39,41 +61,81 @@ var AnimationIndicator = function AnimationIndicator(_ref) {
   /** ***************** component *******************/
   return /*#__PURE__*/jsxs("svg", _objectSpread(_objectSpread({
     "data-ref": "animated-indicator",
-    className: classNames(classes.checkAnimation, className, "inline-block rounded-full", color && getColorClass(color)),
+    className: classNames("fabric-checkAnimation", className, "inline-block rounded-full"),
     style: styles,
     xmlns: "http://www.w3.org/2000/svg",
     viewBox: "0 0 52 52",
     "aria-hidden": "true"
   }, aria), {}, {
     children: [/*#__PURE__*/jsx("circle", {
-      className: classes.circlePart,
+      className: "fabric-circlePart",
       cx: "26",
       cy: "26",
       r: "25"
     }), /*#__PURE__*/jsx("path", {
-      className: classNames(classes.iconPart, getColorClass(strokeColor !== null && strokeColor !== void 0 ? strokeColor : "invert")),
+      className: classNames("fabric-iconPart"),
+      style: {
+        color: strokeColor ? getColor(strokeColor) : "var(--text-color-invert)"
+      },
       d: path
     })]
   }));
 };
+
+/**
+ * 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.
+ */
 var AnimationBars = function AnimationBars(_ref2) {
   var _ref2$color = _ref2.color,
-    color = _ref2$color === void 0 ? "tint" : _ref2$color,
+    color = _ref2$color === void 0 ? "tint-500" : _ref2$color,
     _ref2$size = _ref2.size,
     size = _ref2$size === void 0 ? "2rem" : _ref2$size;
   return /*#__PURE__*/jsx("div", {
     className: classNames("absolute inset-0 z-10 flex justify-center items-center cursor-wait"),
     children: /*#__PURE__*/jsx("div", {
-      className: classNames("outline outline-tint-500/20 p-4 bg-base/50 backdrop-blur-sm rounded"),
+      className: classNames("outline outline-tint-500/20 p-4 bg-tint-50/50 backdrop-blur-sm rounded"),
       children: /*#__PURE__*/jsx("div", {
-        className: classNames(classes.bars, getColorClass(color + "-500/50")),
+        className: classNames("fabric-bars"),
         style: {
-          width: size
+          width: size,
+          color: getColor(color)
         }
       })
     })
   });
 };
+
+/**
+ * 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.
+ */
 var AnimationSpinner = function AnimationSpinner(_ref3) {
   var _ref3$color = _ref3.color,
     color = _ref3$color === void 0 ? "tint-700" : _ref3$color,
@@ -81,28 +143,44 @@ var AnimationSpinner = function AnimationSpinner(_ref3) {
     size = _ref3$size === void 0 ? "2rem" : _ref3$size;
   return /*#__PURE__*/jsx("div", {
     className: classNames("absolute inset-0 z-10 flex justify-center items-center cursor-wait"),
+    "data-ref": "spinner",
     children: /*#__PURE__*/jsx("div", {
-      className: classNames("outline outline-tint-500/20 p-4 bg-base/50 backdrop-blur-sm rounded"),
+      className: classNames("outline outline-tint-500/20 p-4 bg-tint-50/50 backdrop-blur-sm rounded"),
       children: /*#__PURE__*/jsx("div", {
-        className: classNames(classes.spinner, getColorClass(color)),
+        className: classNames("fabric-spinner"),
         style: {
-          width: size
+          width: size,
+          color: getColor(color)
         }
       })
     })
   });
 };
-var Loading = function Loading() {
-  return /*#__PURE__*/jsx("div", {
-    className: classNames(classes.loader, "area-[loader] relative overflow-x-clip"),
-    children: /*#__PURE__*/jsx("div", {
-      className: "absolute z-10 py-px inset-x-0 top-0 after:h-0.5 after:block after:bg-primary-500"
-    })
-  });
-};
-var Skeleton = function Skeleton() {
-  return /*#__PURE__*/jsxs("div", {
-    className: classNames("p-2 animate-pulse flex gap-2 max-w-lg"),
+
+/**
+ * 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.
+ */
+var Skeleton = function Skeleton(_ref4) {
+  var className = _ref4.className,
+    rest = _objectWithoutProperties(_ref4, _excluded2);
+  return /*#__PURE__*/jsxs("div", _objectSpread(_objectSpread({
+    className: classNames(className, "p-2 animate-pulse flex gap-2 max-w-lg"),
+    "data-ref": "skeleton"
+  }, rest), {}, {
     children: [/*#__PURE__*/jsx("div", {
       className: "bg-tint-100 rounded aspect-square h-12"
     }), /*#__PURE__*/jsxs("div", {
@@ -125,6 +203,22 @@ var Skeleton = function Skeleton() {
         })]
       })]
     })]
+  }));
+};
+
+/**
+ * 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.
+ */
+var Loading = function Loading() {
+  return /*#__PURE__*/jsx("div", {
+    className: classNames("fabric-loader", "area-[loader] relative overflow-x-clip"),
+    "data-ref": "loading",
+    children: /*#__PURE__*/jsx("div", {
+      className: "absolute z-10 py-px inset-x-0 top-0 after:h-0.5 after:block after:bg-primary-500"
+    })
   });
 };
 

package/dist/esm/components/avatar/Avatar.js

@@ -6,11 +6,9 @@ import _objectWithoutProperties from '@babel/runtime/helpers/objectWithoutProper
 import { isSvgPath } from '@react-fabric/utilities';
 import BoringAvatar from 'boring-avatars';
 import classNames from 'classnames';
-import { useState } from 'react';
-import { useMemoDebugger } from '../../hooks/useEffectDebugger.js';
-import { getColor, getBgClass, getColorClass } from '../../utils/getColor.js';
-import classes from './Avatar.module.css';
+import { useState, useMemo } from 'react';
 import { jsxs, jsx } from 'react/jsx-runtime';
+import { getColor } from '../../utils/getColor.js';
 
 var _excluded = ["ref", "name", "avatar", "fallbackIcon", "bg", "color", "size", "rounded", "variant", "className", "viewBox", "onClick"];
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
@@ -24,7 +22,32 @@ var SizeMap = {
 };
 
 /**
- * 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.
  */
 var Avatar = function Avatar(_ref) {
   var ref = _ref.ref,
@@ -48,8 +71,9 @@ var Avatar = function Avatar(_ref) {
     fallback = _useState2[0],
     setFallback = _useState2[1];
 
-  /** ***************** style map *******************/
-  var styles = useMemoDebugger(function () {
+  // Memoize styles to avoid unnecessary recalculations
+  // and to ensure styles are only recalculated when dependencies change
+  var styles = useMemo(function () {
     var s = {};
     if (bg) {
       s.backgroundColor = getColor(bg);
@@ -64,15 +88,16 @@ var Avatar = function Avatar(_ref) {
       s.fontSize = SizeMap[size];
     }
     return s;
-  }, [bg, color, size], "Avatar styles");
+  }, [bg, color, size]);
 
-  /** ***************** render icon *******************/
-  var avatarImage = useMemoDebugger(function () {
+  // avatar image
+  // if avatar is not provided, fallback to icon or text
+  var avatarImage = useMemo(function () {
     setFallback(!avatar);
     return avatar && /*#__PURE__*/jsxs("div", {
       className: "contents",
       children: [/*#__PURE__*/jsx("div", {
-        className: classNames(classes.imgPlaceholder, "absolute inset-0 bg-gray animate-pulse")
+        className: classNames("fabric-imgPlaceholder", "absolute inset-0 bg-gray animate-pulse")
       }), /*#__PURE__*/jsx("img", {
         src: avatar,
         alt: avatar,
@@ -86,8 +111,10 @@ var Avatar = function Avatar(_ref) {
         }
       })]
     });
-  }, [avatar], "Avatar icon");
-  var fallbackAvatar = useMemoDebugger(function () {
+  }, [avatar]);
+
+  // render fallback icon or text
+  var fallbackAvatar = useMemo(function () {
     if (fallbackIcon) {
       return isSvgPath(fallbackIcon) ? /*#__PURE__*/jsx("svg", {
         viewBox: viewBox,
@@ -100,8 +127,7 @@ var Avatar = function Avatar(_ref) {
       });
     }
     if (variant === "text") {
-      var _name$match;
-      var _ref2 = (_name$match = name.match(/(?=(\w).* (\w).*)|(?=(\w\w).*)/)) !== null && _name$match !== void 0 ? _name$match : [],
+      var _ref2 = name.match(/(?=(\w).* (\w).*)|(?=(\w\w).*)/),
         _ref3 = _slicedToArray(_ref2, 4),
         first = _ref3[1],
         second = _ref3[2],
@@ -122,16 +148,17 @@ var Avatar = function Avatar(_ref) {
         })
       });
     }
+    // Fallback to BoringAvatar
     return /*#__PURE__*/jsx(BoringAvatar, {
       square: true,
       size: 64,
       variant: variant,
       name: name
     });
-  }, [name, variant, fallbackIcon], "Avatar fallback");
+  }, [name, variant, fallbackIcon]);
   return /*#__PURE__*/jsxs("dfn", _objectSpread(_objectSpread({
     role: "presentation",
-    className: classNames(classes.avatar, className, "select-none relative overflow-hidden inline-block box-content leading-none not-italic text-center", bg && getBgClass(bg), color && getColorClass(color), !rounded && "rounded", rounded && "rounded-full"),
+    className: classNames("fabric-avatar", className, "select-none relative overflow-hidden inline-block box-content leading-none not-italic text-center", !rounded && "rounded", rounded && "rounded-full"),
     onClick: onClick,
     style: styles,
     "data-clickable": !!onClick,

package/dist/esm/components/avatar/AvatarGroup.js

@@ -5,7 +5,6 @@ import _objectWithoutProperties from '@babel/runtime/helpers/objectWithoutProper
 import classNames from 'classnames';
 import { useMemo, Children } from 'react';
 import { useMemoDebugger } from '../../hooks/useEffectDebugger.js';
-import classes from './Avatar.module.css';
 import { jsxs, jsx } from 'react/jsx-runtime';
 
 var _excluded = ["ref", "children", "className", "totalCount", "rounded", "size"];
@@ -20,7 +19,25 @@ var SizeMap = {
 };
 
 /**
- * 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.
  */
 var AvatarGroup = function AvatarGroup(_ref) {
   var ref = _ref.ref,
@@ -49,10 +66,11 @@ var AvatarGroup = function AvatarGroup(_ref) {
   }, [avatars, totalCount]);
   return /*#__PURE__*/jsxs("div", _objectSpread(_objectSpread({}, aria), {}, {
     ref: ref,
-    className: classNames(classes.avatarGroup, className, "inline-flex flex-nowrap", !rounded && "rounded", rounded && "rounded-full"),
+    className: classNames("fabric-avatarGroup", className, "inline-flex flex-nowrap", !rounded && "rounded", rounded && "rounded-full"),
     style: styles,
     children: [avatars, !!diff && /*#__PURE__*/jsx("dfn", {
-      className: classNames(classes.avatar, "select-none relative overflow-hidden inline-block box-content leading-none not-italic text-center", classes.extra),
+      "data-ref": "avatarCount",
+      className: classNames("fabric-avatar", "select-none relative overflow-hidden inline-block box-content leading-none not-italic text-center", "fabric-avatarGroup--extra"),
       children: /*#__PURE__*/jsx("svg", {
         children: /*#__PURE__*/jsx("text", {
           x: "50%",

package/dist/esm/components/badge/Badge.js

@@ -4,16 +4,22 @@ import _defineProperty from '@babel/runtime/helpers/defineProperty';
 import _objectWithoutProperties from '@babel/runtime/helpers/objectWithoutProperties';
 import { isObject, isNil, isNumber, mergeRefs } from '@react-fabric/utilities';
 import classNames from 'classnames';
-import { useMemo, cloneElement } from 'react';
+import { isValidElement, useMemo, cloneElement } from 'react';
 import { Icon } from '../icon/Icon.js';
-import classes from './Badge.module.css';
 import { jsxs, jsx } from 'react/jsx-runtime';
 
-var _excluded = ["ref", "className", "value", "max", "ping", "block", "placement", "children", "forButton", "icon", "iconBg", "iconColor", "rtlFlip"];
+var _excluded = ["ref", "className", "value", "max", "ping", "block", "inline", "placement", "children", "forButton", "icon", "iconBg", "iconColor", "rtlFlip"];
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+/**
+ * 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.
+ */
 var getBadgeProps = function getBadgeProps(badge) {
-  if (isObject(badge)) {
+  if (isObject(badge) && ! /*#__PURE__*/isValidElement(badge)) {
     return Object.assign({
       forButton: true,
       placement: ""
@@ -26,6 +32,25 @@ var getBadgeProps = function getBadgeProps(badge) {
     };
   }
 };
+
+/**
+ * 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.
+ */
 var Badge = function Badge(_ref) {
   var ref = _ref.ref,
     className = _ref.className,
@@ -33,6 +58,7 @@ var Badge = function Badge(_ref) {
     max = _ref.max,
     ping = _ref.ping,
     block = _ref.block,
+    inline = _ref.inline,
     _ref$placement = _ref.placement,
     placement = _ref$placement === void 0 ? "top-end" : _ref$placement,
     children = _ref.children,
@@ -44,6 +70,9 @@ var Badge = function Badge(_ref) {
     rtlFlip = _ref.rtlFlip,
     rest = _objectWithoutProperties(_ref, _excluded);
   var label = useMemo(function () {
+    if ( /*#__PURE__*/isValidElement(value)) {
+      return value;
+    }
     if (!isNil(value)) {
       if (isNumber(value) && max && value > max) {
         return "".concat(max, "+");
@@ -59,14 +88,14 @@ var Badge = function Badge(_ref) {
    * wrap children in a relative div to float badge, wrapper allows for floating a badge on elements with overflow hidden
    */
   return /*#__PURE__*/jsxs("div", {
-    className: classNames(forButton ? "contents" : "relative", block ? "block" : "inline-block"),
+    className: classNames(forButton || inline ? "contents" : block ? "block" : "inline-block", forButton || inline ? "" : "relative"),
     children: [children && /*#__PURE__*/cloneElement(children, _objectSpread(_objectSpread({}, rest), {}, {
       ref: innerRef
-    })), (!!ping || label) && /*#__PURE__*/jsxs("div", {
+    })), (!!ping || (label !== null && label !== void 0 ? label : icon)) && /*#__PURE__*/jsxs("div", {
       "data-ref": "badge",
       "data-ping": ping,
       "data-placement": placement,
-      className: classNames(classes.badge, className, "inline-block p-px min-w-2 min-h-2 text-center select-none rounded-full leading-none z-5 pointer-events-none", forButton && !placement ? "relative" : "absolute"),
+      className: classNames("fabric-badge", className, "inline-block p-px min-w-2 min-h-2 text-center select-none rounded-full leading-none z-2 pointer-events-none", forButton && !placement || inline ? "relative" : "absolute"),
       children: [label && /*#__PURE__*/jsx("span", {
         className: "p-1",
         children: label

package/dist/esm/components/breadcrumbs/Breadcrumbs.js

@@ -5,14 +5,42 @@ import _slicedToArray from '@babel/runtime/helpers/slicedToArray';
 import _objectWithoutProperties from '@babel/runtime/helpers/objectWithoutProperties';
 import classNames from 'classnames';
 import { useMemo, Children } from 'react';
-import { Link } from '../../typography/Link.js';
+import { Anchor } from '../../typography/Anchor.js';
 import { Dropdown } from '../dropdown/Dropdown.js';
-import classes from './Breadcrumbs.module.css';
 import { jsxs, jsx } from 'react/jsx-runtime';
 
 var _excluded = ["variant", "className", "separator", "children", "color"];
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+/**
+ * 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.
+ */
 var Breadcrumbs = function Breadcrumbs(_ref) {
   var _ref$variant = _ref.variant,
     variant = _ref$variant === void 0 ? "classic" : _ref$variant,
@@ -34,13 +62,14 @@ var Breadcrumbs = function Breadcrumbs(_ref) {
     overflow = _useMemo2[1],
     end = _useMemo2[2];
   return /*#__PURE__*/jsxs("nav", _objectSpread(_objectSpread({
+    "data-ref": "breadcrumbs",
     "data-color": color,
     "data-variant": variant,
-    className: classNames(classes.breadcrumbs, className, "flex flex-nowrap items-center")
+    className: classNames("fabric-breadcrumbs", className, "flex flex-nowrap items-center")
   }, aria), {}, {
     children: [start.map(function (link, idx) {
       return /*#__PURE__*/jsx("li", {
-        className: classes.breadcrumbLink,
+        className: "fabric-breadcrumbLink",
         "data-separator": separator,
         children: link
       }, idx);
@@ -48,19 +77,21 @@ var Breadcrumbs = function Breadcrumbs(_ref) {
       closeOnClick: true,
       showArrow: true,
       children: [/*#__PURE__*/jsx("li", {
-        className: classes.breadcrumbLink,
+        className: "fabric-breadcrumbLink",
         "data-separator": separator,
-        children: /*#__PURE__*/jsx(Link, {
+        "data-ref": "breadcrumbOverflow",
+        children: /*#__PURE__*/jsx(Anchor, {
+          "data-": true,
           children: "..."
         })
       }), /*#__PURE__*/jsx("div", {
         "data-color": color,
-        className: classNames(classes.breadcrumbOverflow, "flex flex-col"),
+        className: classNames("fabric-breadcrumbOverflow", "flex flex-col"),
         children: overflow
       })]
     }), end === null || end === void 0 ? void 0 : end.map(function (link, idx) {
       return /*#__PURE__*/jsx("li", {
-        className: classes.breadcrumbLink,
+        className: "fabric-breadcrumbLink",
         "data-separator": separator,
         children: link
       }, idx);