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

package/dist/cjs/components/menu/MenuItem.js

@@ -2,26 +2,47 @@
 
 var _defineProperty = require('@babel/runtime/helpers/defineProperty');
 var _objectWithoutProperties = require('@babel/runtime/helpers/objectWithoutProperties');
-var react = require('@floating-ui/react');
+var react$1 = require('@floating-ui/react');
 var utilities = require('@react-fabric/utilities');
 var classNames = require('classnames');
-var react$1 = require('react');
+var react = require('react');
+var HotKey = require('../../hotkeys/HotKey.js');
 var HotKeyLabel = require('../../hotkeys/HotKeyLabel.js');
 require('@babel/runtime/helpers/slicedToArray');
 require('react-i18next');
 require('../../hooks/useEffectDebugger.js');
 var jsxRuntime = require('react/jsx-runtime');
-require('../../hotkeys/HotKeyWrapper.js');
 var Tooltip = require('../../overlays/tooltip/Tooltip.js');
 var Badge = require('../badge/Badge.js');
 var Icon = require('../icon/Icon.js');
 require('../../types/icons.js');
-var Menu_module = require('./Menu.module.css');
+require('../../hotkeys/HotKeyWrapper.js');
 
-var _excluded = ["as", "label", "color", "className", "icon", "iconBg", "iconColor", "appendLabel", "rtlFlip", "altIcon", "id", "active", "disabled", "onClick", "badge", "hotKey", "minimal", "data-open", "ref"],
+var _excluded = ["as", "label", "color", "className", "icon", "iconBg", "iconColor", "appendLabel", "rtlFlip", "altIcon", "id", "active", "disabled", "onClick", "badge", "hotKey", "tabIndex", "minimal", "data-open", "ref"],
   _excluded2 = ["children"];
 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 menu item component that can be used in a dropdown or menu.
+ * It supports various features such as icons, badges, hotkeys, and more.
+ * It can be customized with different colors, icons, and behaviors.
+ *
+ * @param {MenuItemProps} props
+ * @returns A JSX element representing the menu item.
+ *
+ * @example
+ * ```jsx
+ * <MenuItem
+ *   label="Settings"
+ *   icon="settings"
+ *   onClick={() => console.log("Settings clicked")}
+ *   hotKey="Ctrl+S"
+ *   badge={{ count: 3, color: "red" }}
+ * />
+ * ```
+ *
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/docs/core-components-menu--docs} for documentation.
+ */
 var MenuItem = function MenuItem(_ref) {
   var as = _ref.as,
     label = _ref.label,
@@ -40,29 +61,36 @@ var MenuItem = function MenuItem(_ref) {
     _onClick = _ref.onClick,
     badge = _ref.badge,
     hotKey = _ref.hotKey,
+    _ref$tabIndex = _ref.tabIndex,
+    tabIndex = _ref$tabIndex === void 0 ? -1 : _ref$tabIndex,
     minimal = _ref.minimal,
     childOpen = _ref["data-open"],
     ref = _ref.ref,
     aria = _objectWithoutProperties(_ref, _excluded);
-  var tree = react.useFloatingTree();
-  var badgeProps = react$1.useMemo(function () {
+  var elRef = react.useRef(null);
+  var tree = react$1.useFloatingTree();
+  var badgeProps = react.useMemo(function () {
     return Badge.getBadgeProps(badge);
   }, [badge]);
-  var iconEl = react$1.useMemo(function () {
+  react.useEffect(function () {
+    var _elRef$current;
+    tabIndex === 0 && ((_elRef$current = elRef.current) === null || _elRef$current === void 0 ? void 0 : _elRef$current.focus());
+  }, [tabIndex]);
+  var iconEl = react.useMemo(function () {
     var _path;
     var path = icon;
     if (minimal && !path) {
       path = utilities.iconToken(label);
     }
     return /*#__PURE__*/jsxRuntime.jsx(Icon.Icon, {
-      className: classNames(Menu_module.menuIcon, minimal && Menu_module.minimal),
+      className: classNames("fabric-menuIcon", minimal && "minimal"),
       icon: (_path = path) !== null && _path !== void 0 ? _path : "",
       bg: iconBg,
       color: iconColor,
       rtlFlip: rtlFlip
     });
   }, [icon, iconBg, iconColor, rtlFlip, minimal, label]);
-  var Wrapper = react$1.useCallback(function (_ref2) {
+  var Wrapper = react.useCallback(function (_ref2) {
     var children = _ref2.children,
       rest = _objectWithoutProperties(_ref2, _excluded2);
     return minimal ? /*#__PURE__*/jsxRuntime.jsx(Tooltip.Tooltip, _objectSpread(_objectSpread({
@@ -71,11 +99,11 @@ var MenuItem = function MenuItem(_ref) {
       disabled: childOpen
     }, rest), {}, {
       children: children
-    })) : /*#__PURE__*/jsxRuntime.jsx(react$1.Fragment, {
+    })) : /*#__PURE__*/jsxRuntime.jsx(react.Fragment, {
       children: children
     });
   }, [minimal, label, childOpen]);
-  var menuLabel = react$1.useMemo(function () {
+  var menuLabel = react.useMemo(function () {
     return /*#__PURE__*/jsxRuntime.jsxs("div", {
       className: "flex flex-nowrap text-start items-center",
       children: [iconEl, !minimal && /*#__PURE__*/jsxRuntime.jsx("label", {
@@ -98,20 +126,27 @@ var MenuItem = function MenuItem(_ref) {
   }, [iconEl, minimal, appendLabel, label, badge, badgeProps, hotKey, active]);
   var E = as !== null && as !== void 0 ? as : "button";
   return /*#__PURE__*/jsxRuntime.jsx(Wrapper, _objectSpread(_objectSpread({}, aria), {}, {
-    children: /*#__PURE__*/jsxRuntime.jsx(E, _objectSpread(_objectSpread({
-      ref: ref,
+    children: /*#__PURE__*/jsxRuntime.jsxs(E, _objectSpread(_objectSpread({
+      ref: utilities.mergeRefs(ref, elRef),
       "data-dropdown-dismiss": true,
       "data-color": color,
-      className: classNames(Menu_module.menuItem, className, active && Menu_module.active, minimal && Menu_module.minimal, disabled && Menu_module.disabled, "rounded-capped relative max-w-[50vw] my-0.5"),
+      className: classNames("fabric-menuItem cursor-pointer", className, active && "active", minimal && "minimal", disabled && "disabled", "rounded-capped relative max-w-[50vw] my-0.5"),
       "data-active": active,
       "data-open": childOpen,
       disabled: disabled,
       "data-id": id,
+      tabIndex: tabIndex,
       onClick: function onClick(e) {
         (_onClick === null || _onClick === void 0 ? void 0 : _onClick(e)) !== false && (tree === null || tree === void 0 ? void 0 : tree.events.emit("click"));
       }
     }, minimal ? {} : aria), {}, {
-      children: menuLabel
+      children: [hotKey && /*#__PURE__*/jsxRuntime.jsx(HotKey.HotKey, {
+        keyCombo: hotKey,
+        handler: function handler() {
+          var _elRef$current2, _elRef$current2$click;
+          return (_elRef$current2 = elRef.current) === null || _elRef$current2 === void 0 || (_elRef$current2$click = _elRef$current2.click) === null || _elRef$current2$click === void 0 ? void 0 : _elRef$current2$click.call(_elRef$current2);
+        }
+      }), menuLabel]
     }))
   }));
 };

package/dist/cjs/components/meter/Meter.js

@@ -5,12 +5,35 @@ var _objectWithoutProperties = require('@babel/runtime/helpers/objectWithoutProp
 var utilities = require('@react-fabric/utilities');
 var classNames = require('classnames');
 var useEffectDebugger = require('../../hooks/useEffectDebugger.js');
-var Meter_module = require('./Meter.module.css');
 var jsxRuntime = require('react/jsx-runtime');
 
 var _excluded = ["value", "hideLabel", "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 a visual representation of a value as a series of dots.
+ * It is useful for showing progress or completion status in a compact form.
+ * The meter consists of 6 dots, each representing approximately 16.67% of the total value.
+ * The active dots are filled based on the value provided, and the remaining dots are empty.
+ * The component can also display a label showing the percentage value.
+ *
+ * @param {MeterProps} props - The properties for the Meter component.
+ * @returns {JSX.Element} The rendered Meter component.
+ *
+ * @example
+ * ```jsx
+ * <Meter value={75} />
+ * // Renders a meter with 4 active dots and a label showing "75%"
+ *
+ * <Meter value={50} hideLabel />
+ * // Renders a meter with 3 active dots and no label
+ *
+ * <Meter value={100} className="custom-meter" />
+ * // Renders a meter with all 6 active dots and a custom class name
+ * ```
+ *
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/docs/core-components-meter--docs} for more details.
+ */
 var Meter = function Meter(_ref) {
   var value = _ref.value,
     hideLabel = _ref.hideLabel,
@@ -21,11 +44,11 @@ var Meter = function Meter(_ref) {
     return value / 16.67;
   }, [value], "Meter activeCount");
   return /*#__PURE__*/jsxRuntime.jsxs("div", _objectSpread(_objectSpread({
-    className: classNames(Meter_module.meter, className, "flex flex-nowrap items-center gap-[2px]")
+    className: classNames("fabric-meter", className, "flex flex-nowrap items-center gap-[2px]")
   }, aria), {}, {
     children: [[0, 1, 2, 3, 4, 5].map(function (step) {
       return /*#__PURE__*/jsxRuntime.jsx("div", {
-        className: classNames(Meter_module.meterBar, "first-of-type:rounded-s last-of-type:rounded-e bg-tint-100 relative outline -outline-offset-1 outline-muted overflow-hidden after:absolute after:inset-0"),
+        className: classNames("fabric-meterBar", "first-of-type:rounded-s last-of-type:rounded-e bg-tint-100 relative outline -outline-offset-1 outline-muted overflow-hidden after:absolute after:inset-0"),
         "data-active": activeCount >= step,
         style: {
           "--width": "".concat(Math.min((activeCount - step) * 100, 100), "%")

package/dist/cjs/components/navigator/Navigator.js

@@ -3,49 +3,84 @@
 var _defineProperty = require('@babel/runtime/helpers/defineProperty');
 var _objectWithoutProperties = require('@babel/runtime/helpers/objectWithoutProperties');
 var classNames = require('classnames');
+var react = require('react');
 var HotKey = require('../../hotkeys/HotKey.js');
 var icons = require('../../types/icons.js');
 var Icon = require('../icon/Icon.js');
+var utilities = require('@react-fabric/utilities');
 var jsxRuntime = require('react/jsx-runtime');
 
-var _excluded = ["className", "onNavigate", "color"];
+var _excluded = ["className", "onNavigate", "color", "children", "length", "current", "disableKeyHandlers"];
 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 provides navigation controls for traversing through items.
+ * It includes previous and next buttons, and supports keyboard navigation.
+ *
+ * @param {NavigatorProps} props - The properties for the Navigator component.
+ * @returns {JSX.Element} The rendered Navigator component.
+ *
+ * @example
+ * ```jsx
+ * <Navigator
+ *   className="my-navigator"
+ *   onNavigate={(dir) => console.log(`Navigate ${dir === -1 ? 'previous' : 'next'}`)}
+ *   color="blue"
+ *   length={10}
+ *   current={0}
+ * >
+ *   <span>Current Item: 1</span>
+ * </Navigator>
+ * ```
+ *
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/docs/core-components-navigator--docs} for more details.
+ */
 var Navigator = function Navigator(_ref) {
   var className = _ref.className,
     onNavigate = _ref.onNavigate,
     color = _ref.color,
+    children = _ref.children,
+    length = _ref.length,
+    current = _ref.current,
+    disableKeyHandlers = _ref.disableKeyHandlers,
     aria = _objectWithoutProperties(_ref, _excluded);
+  var navPrev = react.useCallback(function () {
+    return (utilities.isEmpty(current) || current !== 0) && onNavigate(-1);
+  }, [onNavigate, current]);
+  var navNext = react.useCallback(function () {
+    return (utilities.isEmpty(current) || current + 1 < (length !== null && length !== void 0 ? length : 0)) && onNavigate(+1);
+  }, [onNavigate, current, length]);
   return /*#__PURE__*/jsxRuntime.jsxs("div", _objectSpread(_objectSpread({
-    className: classNames(className, "inline-block leading-none")
+    "data-ref": "navigator",
+    className: classNames(className, "inline-flex items-center leading-none")
   }, aria), {}, {
-    children: [/*#__PURE__*/jsxRuntime.jsx(HotKey.HotKey, {
+    children: [!disableKeyHandlers && /*#__PURE__*/jsxRuntime.jsx(HotKey.HotKey, {
       keyCombo: "left",
-      handler: function handler() {
-        return onNavigate(-1);
-      }
-    }), /*#__PURE__*/jsxRuntime.jsx(HotKey.HotKey, {
+      handler: navPrev
+    }), !disableKeyHandlers && /*#__PURE__*/jsxRuntime.jsx(HotKey.HotKey, {
       keyCombo: "right",
-      handler: function handler() {
-        return onNavigate(1);
-      }
+      handler: navNext
     }), /*#__PURE__*/jsxRuntime.jsx(Icon.Icon, {
       rtlFlip: true,
       color: color,
       className: "text-[1em] p-1",
       "aria-label": "previous",
+      "data-ref": "previous",
       icon: icons.CoreIcons.chevronLeft,
+      disabled: !utilities.isEmpty(current) && current === 0,
       onClick: function onClick(e) {
-        return [e.stopPropagation(), onNavigate(-1)];
+        return [e.stopPropagation(), navPrev()];
       }
-    }), /*#__PURE__*/jsxRuntime.jsx(Icon.Icon, {
+    }), children, /*#__PURE__*/jsxRuntime.jsx(Icon.Icon, {
       rtlFlip: true,
       className: "text-[1em] p-1",
       color: color,
       "aria-label": "next",
+      "data-ref": "next",
       icon: icons.CoreIcons.chevronRight,
+      disabled: !utilities.isEmpty(current) && current + 1 === length,
       onClick: function onClick(e) {
-        return [e.stopPropagation(), onNavigate(1)];
+        return [e.stopPropagation(), navNext()];
       }
     })]
   }));

package/dist/cjs/components/panel/Panel.js

@@ -9,12 +9,48 @@ var usePropToggle = require('../../hooks/usePropToggle.js');
 var icons = require('../../types/icons.js');
 var Animations = require('../animations/Animations.js');
 var Icon = require('../icon/Icon.js');
-var Panel_module = require('./Panel.module.css');
 var jsxRuntime = require('react/jsx-runtime');
 
 var _excluded = ["children", "className", "titleClassName", "headerClassName", "title", "actions", "icon", "iconBg", "iconColor", "rtlFlip", "panelId", "height", "width", "minHeight", "minWidth", "maxHeight", "maxWidth", "loading", "expandable", "expanded", "onExpand", "collapsable", "collapsed", "onCollapse", "onClose", "onBack"];
 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 represents a panel with a header, body, and optional actions.
+ * It supports expandable and collapsible functionality, loading state, and customizable styles.
+ * The panel can be resized and has a fixed position when expanded.
+ * It can be customized with different colors, icons, and behaviors.
+ * This component is useful for displaying content in a structured way, allowing users to interact with it through actions and toggles.
+ * It can be used in various applications where panels are needed, such as dashboards, settings pages, or content management systems.
+ *
+ * @param {PanelProps} props - The properties for the Panel component.
+ * @returns {JSX.Element} The rendered Panel component.
+ *
+ * @example
+ * ```jsx
+ * <Panel
+ *   title="Panel Title"
+ *   icon={CoreIcons.info}
+ *   iconBg="bg-blue-500"
+ *   iconColor="text-white"
+ *   actions={<button>Action</button>}
+ *   expandable
+ *   collapsable
+ *   onExpand={() => console.log("Expanded")}
+ *   onCollapse={() => console.log("Collapsed")}
+ *   onClose={() => console.log("Closed")}
+ *   height="400px"
+ *   width="300px"
+ *   minHeight="200px"
+ *   minWidth="200px"
+ *   maxHeight="600px"
+ *   maxWidth="600px"
+ * >
+ *   <p>This is the content of the panel.</p>
+ * </Panel>
+ * ```
+ *
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/docs/core-components-panel--docs} for more details.
+ */
 var Panel = function Panel(_ref) {
   var children = _ref.children,
     className = _ref.className,
@@ -55,7 +91,7 @@ var Panel = function Panel(_ref) {
     return !!expandable || !!collapsable || !!onClose;
   }, [expandable, collapsable, onClose]);
   return /*#__PURE__*/jsxRuntime.jsxs("div", _objectSpread(_objectSpread({
-    className: classNames(Panel_module.panel, className, "rounded-capped overflow-hidden outline grid", expanded ? "fixed inset-4 z-50" : "relative"),
+    className: classNames("fabric-panel", className, "rounded-capped overflow-hidden outline grid", expanded ? "fixed inset-4 z-50" : "relative"),
     "data-ref": "panel",
     "data-collapsed": collapsed,
     style: expanded ? {} : collapsed ? {
@@ -73,11 +109,12 @@ var Panel = function Panel(_ref) {
   }, aria), {}, {
     children: [/*#__PURE__*/jsxRuntime.jsxs("header", {
       role: "none",
-      className: classNames(Panel_module.panelHeader, headerClassName, "flex flex-nowrap items-center area-head"),
+      className: classNames("fabric-panelHeader", headerClassName, "flex flex-nowrap items-center area-head"),
+      "data-ref": "panelHeader",
       onClick: collapsable ? toggleCollapse : undefined,
       children: [onBack && /*#__PURE__*/jsxRuntime.jsx(Icon.Icon, {
         "data-ref": "panelBack",
-        className: classNames(Panel_module.panelAction, "cursor-pointer"),
+        className: classNames("fabric-panelAction", "cursor-pointer"),
         icon: icons.CoreIcons.chevronLeft,
         onClick: onBack
       }), icon && /*#__PURE__*/jsxRuntime.jsx(Icon.Icon, {
@@ -90,7 +127,7 @@ var Panel = function Panel(_ref) {
         className: classNames(titleClassName, "flex-1 select-none truncate", title && "py-1 first:px-2"),
         children: title
       }), /*#__PURE__*/jsxRuntime.jsx("div", {
-        className: "px-1",
+        className: "px-1 leading-none",
         children: actions
       }), hasTools && /*#__PURE__*/jsxRuntime.jsxs("div", {
         role: "none",
@@ -100,23 +137,24 @@ var Panel = function Panel(_ref) {
         },
         children: [expandable && /*#__PURE__*/jsxRuntime.jsx(Icon.Icon, {
           "data-ref": "panelExpand",
-          className: classNames(Panel_module.panelAction, "cursor-pointer"),
+          className: classNames("fabric-panelAction", "cursor-pointer"),
           icon: expanded ? icons.CoreIcons.minimize : icons.CoreIcons.maximize,
           onClick: toggleExpand
         }), !expanded && collapsable && /*#__PURE__*/jsxRuntime.jsx(Icon.Icon, {
           "data-ref": "panelCollapse",
-          className: classNames(Panel_module.panelAction, "cursor-pointer"),
+          className: classNames("fabric-panelAction", "cursor-pointer"),
           icon: collapsed ? icons.CoreIcons.expand : icons.CoreIcons.collapse,
           onClick: toggleCollapse
         }), !expanded && onClose && /*#__PURE__*/jsxRuntime.jsx(Icon.Icon, {
           "data-ref": "panelClose",
-          className: classNames(Panel_module.panelAction, "cursor-pointer"),
+          className: classNames("fabric-panelAction", "cursor-pointer"),
           icon: icons.CoreIcons.close,
           onClick: onClose
         })]
       })]
     }), (!collapsed || expanded) && /*#__PURE__*/jsxRuntime.jsxs("div", {
-      className: classNames(Panel_module.panelBody, "area-content grid overflow-hidden"),
+      "data-ref": "panelBody",
+      className: classNames("fabric-panelBody", "area-content grid overflow-hidden"),
       children: [loading && /*#__PURE__*/jsxRuntime.jsx(Animations.Loading, {}), children]
     })]
   }));

package/dist/cjs/components/panel/PanelGroup.js

@@ -4,9 +4,32 @@ var _slicedToArray = require('@babel/runtime/helpers/slicedToArray');
 var classNames = require('classnames');
 var react = require('react');
 var useEffectDebugger = require('../../hooks/useEffectDebugger.js');
-var Panel_module = require('./Panel.module.css');
 var jsxRuntime = require('react/jsx-runtime');
 
+/**
+ * A component that groups multiple panels together, allowing for one panel to be expanded at a time.
+ * This component allows you to manage a group of panels where only one can be expanded at a time.
+ * It accepts an `activePanel` prop to control which panel is currently expanded,
+ * and an `onActiveChange` callback that is triggered when the active panel changes.
+ * It uses the `Panel` component to render each individual panel within the group.
+ *
+ * @param {PanelGroupProps} props - The properties for the PanelGroup component.
+ * @returns {JSX.Element} The rendered PanelGroup component.
+ *
+ * @example
+ * ```jsx
+ * <PanelGroup
+ *   activePanel="panel1"
+ *   onActiveChange={(panelId) => console.log(`Active panel changed to: ${panelId}`)}
+ * >
+ *   <Panel panelId="panel1" title="Panel 1">Content for Panel 1</Panel>
+ *   <Panel panelId="panel2" title="Panel 2">Content for Panel 2</Panel>
+ *   <Panel panelId="panel3" title="Panel 3">Content for Panel 3</Panel>
+ * </PanelGroup>
+ * ```
+ *
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/docs/core-components-panel--docs} for more details.
+ */
 var PanelGroup = function PanelGroup(_ref) {
   var children = _ref.children,
     activePanel = _ref.activePanel,
@@ -33,7 +56,7 @@ var PanelGroup = function PanelGroup(_ref) {
   }, [onActiveChange, expandedPanel]);
   return /*#__PURE__*/jsxRuntime.jsx("div", {
     "data-ref": "panelGroup",
-    className: classNames(Panel_module.panelGroup, "flex flex-col overflow-auto area-content p-px"),
+    className: classNames("fabric-panelGroup", "flex flex-col overflow-auto area-content p-px"),
     children: react.Children.toArray(children).map(function (child, index) {
       return /*#__PURE__*/react.cloneElement(child, {
         panelId: child.props.panelId || index,

package/dist/cjs/components/panel/PanelStack.js

@@ -10,6 +10,37 @@ var jsxRuntime = require('react/jsx-runtime');
 var _excluded = ["active", "children", "className", "onPanelChange", "onBack"];
 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 manages a stack of panels, allowing navigation between them.
+ * This component allows you to manage a stack of panels where you can navigate between them.
+ * It accepts an `active` prop to control which panel is currently active,
+ * an `onPanelChange` callback that is triggered when the active panel changes,
+ * and an `onBack` callback to handle navigation to the previous panel in the history.
+ * It uses the `Panel` component to render each individual panel within the stack.
+ * The component maintains a history of panels to allow back navigation,
+ * and it updates the active panel based on user interactions.
+ *
+ * @param {PanelStackProps} props - The properties for the PanelStack component.
+ * @returns {JSX.Element} The rendered PanelStack component.
+ *
+ * @example
+ * ```jsx
+ * <PanelStack
+ *   active="panel1"
+ *   onPanelChange={(panelId) => console.log(`Active panel changed to: ${panelId}`)}
+ *   onBack={(currentPanel, nextPanel) => {
+ *     console.log(`Navigating back from ${currentPanel} to ${nextPanel}`);
+ *     return true; // return false to prevent navigation
+ *   }}
+ * >
+ *   <Panel panelId="panel1" title="Panel 1">Content for Panel 1</Panel>
+ *   <Panel panelId="panel2" title="Panel 2">Content for Panel 2</Panel>
+ *   <Panel panelId="panel3" title="Panel 3">Content for Panel 3</Panel>
+ * </PanelStack>
+ * ```
+ *
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/docs/core-components-panelstack--docs} for more details.
+ */
 var PanelStack = function PanelStack(_ref) {
   _ref.active;
     var children = _ref.children,

package/dist/cjs/components/progress/ProgressBar.js

@@ -4,9 +4,9 @@ var _defineProperty = require('@babel/runtime/helpers/defineProperty');
 var utilities = require('@react-fabric/utilities');
 var classNames = require('classnames');
 var useEffectDebugger = require('../../hooks/useEffectDebugger.js');
-var getColor = require('../../utils/getColor.js');
-var Progress_module = require('./Progress.module.css');
+require('react');
 var jsxRuntime = require('react/jsx-runtime');
+var getColor = require('../../utils/getColor.js');
 
 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; }
@@ -19,29 +19,51 @@ var SizeMap = {
   lg: "1.5rem",
   xl: "2rem"
 };
+
+/**
+ * A component that displays a progress bar indicating the completion percentage of a task or operation.
+ * The progress bar is styled with a background color and a track that fills based on the value provided.
+ * It can also display a label showing the percentage value.
+ * The label can be customized or hidden based on the props provided.
+ *
+ * @param {ProgressProps} props - The properties for the ProgressBar component.
+ * @returns {JSX.Element} The rendered ProgressBar component.
+ *
+ * @example
+ * ```jsx
+ * <ProgressBar value={0.75} size="md" color="primary-500" label="Loading" animate />
+ * // Renders a progress bar with 75% completion, medium size, primary color, and a label "Loading"
+ *
+ * <ProgressBar value={0.5} size="lg" color="success-500" />
+ * // Renders a progress bar with 50% completion, large size, and success color without a label
+ * ```
+ *
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/docs/core-components-progress--docs} for more details.
+ */
 var ProgressBar = function ProgressBar(_ref) {
   var _ref$value = _ref.value,
     value = _ref$value === void 0 ? 0 : _ref$value,
     size = _ref.size,
     _ref$color = _ref.color,
-    color = _ref$color === void 0 ? "primary" : _ref$color,
+    color = _ref$color === void 0 ? "primary-500" : _ref$color,
     _ref$label = _ref.label,
     label = _ref$label === void 0 ? "" : _ref$label,
     animate = _ref.animate;
   /** ***************** make sure value is between 0 and 100 *******************/
   var actualValue = useEffectDebugger.useMemoDebugger(function () {
-    return Math.min(Math.max(value, 0), 100);
+    return Math.min(Math.max(value, 0), 1);
   }, [value], "ProgressBar value");
   var progressVar = useEffectDebugger.useMemoDebugger(function () {
     return {
-      "--progress": actualValue
+      "--progress": actualValue * 100
     };
   }, [actualValue], "ProgressBar cssVar");
 
   /** ***************** component *******************/
   return /*#__PURE__*/jsxRuntime.jsxs("div", {
-    className: classNames(Progress_module.progressbar, getColor.getColorClass(color), "block bg-dimmed relative rounded font-bold overflow-hidden whitespace-nowrap"),
+    className: classNames("fabric-progressbar", "block bg-dimmed relative rounded font-bold overflow-hidden whitespace-nowrap"),
     style: _objectSpread(_objectSpread({}, progressVar), {}, {
+      color: getColor.getColor(color),
       minHeight: SizeMap[size !== null && size !== void 0 ? size : ""],
       fontSize: SizeMap[size !== null && size !== void 0 ? size : ""]
     }),
@@ -49,12 +71,12 @@ var ProgressBar = function ProgressBar(_ref) {
     "aria-hidden": "true",
     children: [!["xxs", "xs", "sm"].includes(size !== null && size !== void 0 ? size : "") && /*#__PURE__*/jsxRuntime.jsxs("div", {
       className: "absolute inset-0 text-center z-0 align-top",
-      children: [label, " ", utilities.Format.percent(actualValue / 100)]
+      children: [label, " ", utilities.Format.percent(actualValue)]
     }), /*#__PURE__*/jsxRuntime.jsx("div", {
-      className: classNames(Progress_module.progressTrack, animate && Progress_module.progressAnimate, "h-full overflow-clip bg-current relative z-0")
+      className: classNames("fabric-progressTrack", animate && "fabric-progressAnimate", "h-full overflow-clip bg-current relative z-0")
     }), !["xxs", "xs", "sm"].includes(size !== null && size !== void 0 ? size : "") && /*#__PURE__*/jsxRuntime.jsx("div", {
       className: classNames("h-full absolute inset-0 overflow-hidden z-1"),
-      "data-label": "".concat(label, " ").concat(utilities.Format.percent(actualValue / 100))
+      "data-label": "".concat(label, " ").concat(utilities.Format.percent(actualValue))
     })]
   });
 };

package/dist/cjs/components/progress/ProgressCircle.js

@@ -3,8 +3,9 @@
 var utilities = require('@react-fabric/utilities');
 var classNames = require('classnames');
 var useEffectDebugger = require('../../hooks/useEffectDebugger.js');
-var getColor = require('../../utils/getColor.js');
+require('react');
 var jsxRuntime = require('react/jsx-runtime');
+var getColor = require('../../utils/getColor.js');
 
 /*
  * React Fabric
@@ -36,30 +37,51 @@ var SizeMap = {
   lg: "1.5rem",
   xl: "2rem"
 };
+
+/**
+ * A circular progress indicator that visually represents a percentage of completion.
+ * It displays a circular track with a stroke that fills based on the `value` prop.
+ * The component is customizable with size and color props.
+ *
+ * @param {ProgressProps} props - The properties for the ProgressCircle component.
+ * @returns {JSX.Element} - A circular progress indicator.
+ *
+ * @example
+ * ```jsx
+ * <ProgressCircle value={0.75} size="md" color="primary-500" />
+ * // Renders a circular progress indicator with 75% completion, medium size, and primary color.
+ *
+ * <ProgressCircle value={0.5} size="lg" color="secondary-500" />
+ * // Renders a circular progress indicator with 50% completion, large size, and secondary color.
+ * ```
+ *
+ * @see {@link https://adarshpastakia.github.io/react-fabric/?path=/docs/core-components-progress--docs} for more details.
+ */
 var ProgressCircle = function ProgressCircle(_ref) {
   var _ref$value = _ref.value,
     value = _ref$value === void 0 ? 0 : _ref$value,
     _ref$size = _ref.size,
     size = _ref$size === void 0 ? "sm" : _ref$size,
     _ref$color = _ref.color,
-    color = _ref$color === void 0 ? "primary" : _ref$color;
+    color = _ref$color === void 0 ? "primary-500" : _ref$color;
   /** ***************** make sure value is between 0 and 100 *******************/
   var actualValue = useEffectDebugger.useMemoDebugger(function () {
-    return Math.min(Math.max(value, 0), 100);
+    return Math.min(Math.max(value, 0), 1);
   }, [value], "ProgressCirle value");
 
   /** ***************** calculate stroke offset by actual value *******************/
   var strokeDashoffset = useEffectDebugger.useMemoDebugger(function () {
     var circumfrence = Math.PI * 2 * 44;
-    return circumfrence * (1 - actualValue / 100);
+    return circumfrence * (1 - actualValue);
   }, [actualValue], "ProgressCirle dashOffset");
 
   /** ***************** component *******************/
   return /*#__PURE__*/jsxRuntime.jsxs("div", {
-    className: classNames("inline-block w-[4em] h-[4em] text-lg relative", getColor.getColorClass(color)),
+    className: classNames("inline-block w-[4em] h-[4em] text-lg relative"),
     "aria-hidden": "true",
     style: {
-      fontSize: SizeMap[size]
+      fontSize: SizeMap[size],
+      color: getColor.getColor(color)
     },
     children: [/*#__PURE__*/jsxRuntime.jsxs("svg", {
       viewBox: "0 0 100 100",
@@ -88,7 +110,7 @@ var ProgressCircle = function ProgressCircle(_ref) {
       })]
     }), /*#__PURE__*/jsxRuntime.jsx("span", {
       className: "flex w-full h-full items-center justify-center select-none font-bold text-[0.625em]",
-      children: utilities.Format.percent(actualValue / 100)
+      children: utilities.Format.percent(actualValue)
     })]
   });
 };