import { ClassComponent } from '../ts-helpers.d';

export type BreadcrumbMenu = {
  /**
   * This is the text that will be displayed for the menu item.
   */
  name: string;
  /**
   * This is the URL that the menu item will link to.
   * If not provided, the menu item will be displayed as a label instead of a link.
   */
  route?: string;
  /**
   * This is the title attribute for the link.
   * It is only used if the menu item has a route.
   */
  title?: string;
};

export interface BreadcrumbProps {
  /**
   * The list of breadcrumb menu to display.
   * If not provided, the breadcrumb will use the breadcrumb store.
   */
  menus?: BreadcrumbMenu[];
}

/**
 * **WangsVue - Breadcrumb**
 *
 * _Breadcrumb is a component for displaying a breadcrumb trail to help users navigate a website or application.
 * It takes an array of menu items as a prop and displays each item as a link or label, with a separator between them._
 *
 * @group components
 */
declare class Breadcrumb extends ClassComponent<
  BreadcrumbProps,
  unknown,
  unknown
> {}

export default Breadcrumb;