@bolttech/ob-atoms-breadcrumbs 1.0.0

package/index.d.ts

@@ -0,0 +1 @@
+export * from "./src/index";

package/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "@bolttech/ob-atoms-breadcrumbs",
+  "version": "1.0.0",
+  "dependencies": {
+    "@bolttech/ui-utils": "0.6.5",
+    "react": "19.1.1",
+    "@bolttech/ob-atoms-icon": "1.0.0"
+  },
+  "main": "./index.cjs.js",
+  "type": "commonjs",
+  "types": "./index.d.ts"
+}

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;