@muraldevkit/ui-toolkit 4.39.2-dev-MDdX.1 → 4.40.0

package/dist/components/breadcrumb/MrlBreadcrumbItem/MrlBreadcrumbItem.d.ts

@@ -0,0 +1,44 @@
+import * as React from 'react';
+import { Link } from 'react-router-dom';
+export type BreadcrumbItemLink = {
+    text: string;
+    link: string;
+} | {
+    text: string;
+    link: React.ComponentPropsWithoutRef<typeof Link>;
+};
+export type BreadcrumbItem = {
+    isSelected?: boolean;
+    hasSeparator?: boolean;
+    isTruncated?: boolean;
+} & BreadcrumbItemLink;
+export interface MrlBreadcrumbItemProps extends React.ComponentPropsWithRef<'li'> {
+    /**
+     * Children to be rendered within the component
+     */
+    children?: React.ReactNode;
+    /**
+     * Determines whether a separator should be displayed after this breadcrumb item.
+     */
+    hasSeparator?: BreadcrumbItem['hasSeparator'];
+    /**
+     * Indicates whether this breadcrumb item represents the currently selected or
+     * active page.
+     */
+    isSelected?: BreadcrumbItem['isSelected'];
+    /**
+     * Specifies whether the text content of this breadcrumb item should be truncated
+     * if it exceeds a certain width. This is useful for handling long page titles
+     * or labels within the breadcrumb.
+     */
+    isTruncated?: boolean;
+    link?: BreadcrumbItem['link'];
+    text?: BreadcrumbItem['text'];
+}
+/**
+ * MrlBreadcrumbItem component.
+ *
+ * @param props The MrlBreadcrumbItem component properties.
+ * @returns The MrlBreadcrumbItem component.
+ */
+export declare function MrlBreadcrumbItem(props: MrlBreadcrumbItemProps): JSX.Element;

package/dist/components/breadcrumb/MrlBreadcrumbItem/index.d.ts

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

package/dist/components/breadcrumb/MrlBreadcrumbSeparator/MrlBreadcrumbSeparator.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+/**
+ * MrlBreadcrumbSeparator component.
+ *
+ * @returns The MrlBreadcrumbSeparator component.
+ */
+export declare function MrlBreadcrumbSeparator(): JSX.Element;

package/dist/components/breadcrumb/MrlBreadcrumbSeparator/index.d.ts

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

package/dist/components/breadcrumb/MrlBreadcrumbs/MrlBreadcrumbs.d.ts

@@ -0,0 +1,29 @@
+import * as React from 'react';
+import { BreadcrumbItem } from '../MrlBreadcrumbItem';
+/**
+ * Props for the MrlBreadcrumbs component.
+ */
+export interface MrlBreadcrumbsProps extends React.ComponentPropsWithRef<'nav'> {
+    /**
+     * A string value used for data-qa attribute.
+     */
+    ['data-qa']?: string;
+    /**
+     * The aria-label of the nav element
+     */
+    ['aria-label']: string;
+    /**
+     * This prop accepts an array of objects, where each object represents a single breadcrumb item.
+     * It's used to define the structure, content, and behavior of the breadcrumbs displayed in the component.
+     * The `link` prop could be either the props of a react-router-dom link or a string. If a string is provided it will
+     * render a regular link.
+     */
+    items: BreadcrumbItem[];
+}
+/**
+ * MrlBreadcrumbs component.
+ *
+ * @param props The MrlBreadcrumbs component properties.
+ * @returns The MrlBreadcrumbs component.
+ */
+export declare function MrlBreadcrumbs(props: MrlBreadcrumbsProps): JSX.Element;

package/dist/components/breadcrumb/MrlBreadcrumbs/index.d.ts

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

package/dist/components/breadcrumb/index.d.ts

@@ -0,0 +1,3 @@
+export * from './MrlBreadcrumbItem';
+export * from './MrlBreadcrumbs';
+export * from './MrlBreadcrumbSeparator';

package/dist/components/index.d.ts

@@ -30,3 +30,4 @@ export * from './panel';
 export * from './rovingTabindex';
 export * from './toolbar';
 export * from './filter';
+export * from './breadcrumb';

package/dist/components/svg/config.d.ts

@@ -80,7 +80,7 @@ export declare const colorPictoStoryData: {
 export declare const animateStoryData: {
     args: {
         delay: number;
-        state: "stop" | "play";
+        state: "play" | "stop";
     };
     argTypes: {
         delay: {