@bolttech/ob-atoms-breadcrumbs 1.0.1 → 1.0.2

package/index.cjs.js

@@ -1,19 +1,9 @@
 'use strict';
 
+var jsxRuntime = require('react/jsx-runtime');
 var react = require('react');
 var uiUtils = require('@bolttech/ui-utils');
 var obAtomsIcon = require('@bolttech/ob-atoms-icon');
-var jsxDevRuntime = require('react/jsx-dev-runtime');
-
-function _objectWithoutPropertiesLoose(r, e) {
-  if (null == r) return {};
-  var t = {};
-  for (var n in r) if ({}.hasOwnProperty.call(r, n)) {
-    if (-1 !== e.indexOf(n)) continue;
-    t[n] = r[n];
-  }
-  return t;
-}
 
 var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
 
@@ -1963,16 +1953,48 @@ for (var COLLECTION_NAME in DOMIterables) {
 
 handlePrototype(DOMTokenListPrototype, 'DOMTokenList');
 
-const _excluded = ["id", "dataTestId", "items", "ariaLabel"];
-var _jsxFileName = "/home/silas-silva/Documents/projects/bgs-frontend-ui/libs/ob/atoms/breadcrumbs/src/lib/breadcrumbs.tsx";
-const Breadcrumbs = /*#__PURE__*/react.forwardRef((_ref, ref) => {
-  let {
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+/* global Reflect, Promise, SuppressedError, Symbol, Iterator */
+
+
+function __rest(s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+}
+
+typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+};
+
+const Breadcrumbs = /*#__PURE__*/react.forwardRef((_a, ref) => {
+  var {
       id = 'breadcrumbs-id',
       dataTestId = 'breadcrumbs-data-testid',
       items,
       ariaLabel = 'Show complete navigation.'
-    } = _ref,
-    props = _objectWithoutPropertiesLoose(_ref, _excluded);
+    } = _a,
+    props = __rest(_a, ["id", "dataTestId", "items", "ariaLabel"]);
   const [expanded, setExpanded] = react.useState(false);
   const shouldShrink = items.length > 5;
   const filteredItems = react.useMemo(() => {
@@ -1987,54 +2009,34 @@ const Breadcrumbs = /*#__PURE__*/react.forwardRef((_ref, ref) => {
     return filteredItems.map((item, index) => {
       // Last item
       if (index === items.length - 1 || shouldShrink && index === filteredItems.length - 1) {
-        return /*#__PURE__*/jsxDevRuntime.jsxDEV("li", {
+        return jsxRuntime.jsx("li", {
           className: "flex items-center",
           "aria-current": "page",
           children: item.label
-        }, index, false, {
-          fileName: _jsxFileName,
-          lineNumber: 39,
-          columnNumber: 13
-        }, undefined);
+        }, index);
       }
       if (shouldShrink && index === 1) {
-        return [/*#__PURE__*/jsxDevRuntime.jsxDEV("li", {
+        return [jsxRuntime.jsx("li", {
           className: "flex items-center",
-          children: /*#__PURE__*/jsxDevRuntime.jsxDEV("button", {
+          children: jsxRuntime.jsx("button", {
             type: "button",
             className: "cursor-pointer",
             onClick: item.onClick,
             "aria-expanded": "false",
             "aria-label": ariaLabel,
             children: item.label
-          }, void 0, false, {
-            fileName: _jsxFileName,
-            lineNumber: 48,
-            columnNumber: 15
-          }, undefined)
-        }, index, false, {
-          fileName: _jsxFileName,
-          lineNumber: 47,
-          columnNumber: 13
-        }, undefined), /*#__PURE__*/jsxDevRuntime.jsxDEV("li", {
+          })
+        }, index), jsxRuntime.jsx("li", {
           className: "flex items-center",
           "aria-hidden": true,
-          children: /*#__PURE__*/jsxDevRuntime.jsxDEV(obAtomsIcon.Icon, {
+          children: jsxRuntime.jsx(obAtomsIcon.Icon, {
             icon: "chevron_right"
-          }, void 0, false, {
-            fileName: _jsxFileName,
-            lineNumber: 63,
-            columnNumber: 15
-          }, undefined)
-        }, `divider-${index}`, false, {
-          fileName: _jsxFileName,
-          lineNumber: 58,
-          columnNumber: 13
-        }, undefined)];
+          })
+        }, `divider-${index}`)];
       }
-      return [/*#__PURE__*/jsxDevRuntime.jsxDEV("li", {
+      return [jsxRuntime.jsx("li", {
         className: "flex items-center",
-        children: /*#__PURE__*/jsxDevRuntime.jsxDEV("a", {
+        children: jsxRuntime.jsx("a", {
           href: item.href,
           onClick: event => {
             if (item && item.onClick) {
@@ -2044,52 +2046,28 @@ const Breadcrumbs = /*#__PURE__*/react.forwardRef((_ref, ref) => {
           },
           "aria-current": "page",
           children: item.label
-        }, void 0, false, {
-          fileName: _jsxFileName,
-          lineNumber: 70,
-          columnNumber: 13
-        }, undefined)
-      }, index, false, {
-        fileName: _jsxFileName,
-        lineNumber: 69,
-        columnNumber: 11
-      }, undefined), /*#__PURE__*/jsxDevRuntime.jsxDEV("li", {
+        })
+      }, index), jsxRuntime.jsx("li", {
         className: "flex items-center",
         "aria-hidden": true,
-        children: /*#__PURE__*/jsxDevRuntime.jsxDEV(obAtomsIcon.Icon, {
+        children: jsxRuntime.jsx(obAtomsIcon.Icon, {
           icon: "chevron_right"
-        }, void 0, false, {
-          fileName: _jsxFileName,
-          lineNumber: 88,
-          columnNumber: 13
-        }, undefined)
-      }, `divider-${index}`, false, {
-        fileName: _jsxFileName,
-        lineNumber: 83,
-        columnNumber: 11
-      }, undefined)];
+        })
+      }, `divider-${index}`)];
     });
   }, [ariaLabel, filteredItems, items.length, shouldShrink]);
-  return /*#__PURE__*/jsxDevRuntime.jsxDEV("nav", Object.assign({
+  return jsxRuntime.jsx("nav", Object.assign({
     ref: ref,
     "aria-label": "Breadcrumb",
     id: id,
     className: "breadcrumb-container",
     "data-testid": dataTestId
   }, uiUtils.applyDataAttributes(props), {
-    children: /*#__PURE__*/jsxDevRuntime.jsxDEV("ol", {
+    children: jsxRuntime.jsx("ol", {
       className: "flex flex-row items-center min-w-max gap-(--breadcrumb-cotent-gap)",
       children: renderLinks()
-    }, void 0, false, {
-      fileName: _jsxFileName,
-      lineNumber: 103,
-      columnNumber: 9
-    }, undefined)
-  }), void 0, false, {
-    fileName: _jsxFileName,
-    lineNumber: 95,
-    columnNumber: 7
-  }, undefined);
+    })
+  }));
 });
 
 exports.Breadcrumbs = Breadcrumbs;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bolttech/ob-atoms-breadcrumbs",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "dependencies": {
     "@bolttech/ui-utils": "0.6.7",
     "react": "19.1.2",

package/src/index.d.ts

@@ -0,0 +1 @@
+export * from './lib/breadcrumbs';

package/src/lib/breadcrumbs.d.ts

@@ -0,0 +1,3 @@
+import { IBreadcrumbProps } from './breadcrumbs.interface';
+import './breadcrumbs.css';
+export declare const Breadcrumbs: import("react").ForwardRefExoticComponent<IBreadcrumbProps & import("react").RefAttributes<HTMLDivElement>>;

package/src/lib/breadcrumbs.interface.d.ts

@@ -0,0 +1,25 @@
+import { DefaultProps } from '@bolttech/ui-utils';
+/**
+ * @type {BreadcrumbItem}
+ * @property {string} label Label that should be displayed on the Breadcrumb Item
+ * @property {string} href Url of each Breadcrumb Item
+ * @property {Function} onClick (Optional) On Click event for each Breadcrumb Item
+ */
+export type BreadcrumbItem = {
+    label: string;
+    href?: string;
+    onClick?: () => void;
+};
+/**
+ * @interface IBreadcrumbProps
+ * @member {string} id A unique identifier for the Breadcrumb component, used for identifying specific instances.
+ * @member {string} dataTestId A data-testid attribute for testing purposes, making the component easy to target in tests.
+ * @member {Array<BreadcrumbItem>} items A required array of breadcrumb items. Each item should be an object containing label and href properties.
+ * @member {string} ariaLabel Optional parameter for accessibility purposes. This should be used for the expand item, providing a description for this action.
+ */
+export interface IBreadcrumbProps extends DefaultProps {
+    id?: string;
+    dataTestId?: string;
+    items: BreadcrumbItem[];
+    ariaLabel?: string;
+}

package/src/lib/breadcrumbs.stories.d.ts

@@ -0,0 +1,24 @@
+import { type StoryObj } from '@storybook/react-vite';
+declare const meta: {
+    title: string;
+    component: import("react").ForwardRefExoticComponent<import("./breadcrumbs.interface").IBreadcrumbProps & import("react").RefAttributes<HTMLDivElement>>;
+    argTypes: {
+        id: {
+            type: "string";
+            description: string;
+        };
+        dataTestId: {
+            type: "string";
+            description: string;
+        };
+        items: {
+            description: string;
+        };
+        ariaLabel: {
+            description: string;
+        };
+    };
+};
+export default meta;
+type Story = StoryObj<typeof meta>;
+export declare const Default: Story;