@yamada-ui/react/dist/types/components/breadcrumb/breadcrumb.d.ts

React UI components of the Yamada, by the Yamada, for the Yamada built with React and Emotion

import { ThemeProps } from "../../core/system/index.types.js";
import { Component, HTMLStyledProps } from "../../core/components/index.types.js";
import "../../core/index.js";
import { BreadcrumbStyle } from "./breadcrumb.style.js";
import { UseBreadcrumbProps } from "./use-breadcrumb.js";
import "../../index.js";
import * as react40 from "react";
import { ReactElement } from "react";

//#region src/components/breadcrumb/breadcrumb.d.ts
interface BreadcrumbRootProps extends HTMLStyledProps<"nav">, ThemeProps<BreadcrumbStyle>, Omit<UseBreadcrumbProps, "endBoundaries" | "startBoundaries"> {
  /**
   * Number of elements visible on the end(right) edges.
   *
   * @default 0
   */
  endBoundaries?: number;
  /**
   * The visual separator between each breadcrumb item.
   *
   * @default '/'
   */
  separator?: ReactElement | string;
  /**
   * Number of elements visible on the start(left) edges.
   *
   * @default 0
   */
  startBoundaries?: number;
  /**
   * Props for item element.
   */
  itemProps?: BreadcrumbItemProps;
  /**
   * Props for ol element.
   */
  listProps?: HTMLStyledProps<"ol">;
  /**
   * Props for separator element.
   */
  separatorProps?: BreadcrumbSeparatorProps;
}
declare const BreadcrumbPropsContext: react40.Context<Partial<BreadcrumbRootProps> | undefined>, useBreadcrumbPropsContext: () => Partial<BreadcrumbRootProps> | undefined;
/**
 * `Breadcrumb` is a component that helps users understand the hierarchy of a website.
 *
 * @see https://yamada-ui.com/docs/components/breadcrumb
 */
declare const BreadcrumbRoot: Component<"nav", BreadcrumbRootProps>;
interface BreadcrumbItemProps extends HTMLStyledProps<"li"> {}
interface BreadcrumbSeparatorProps extends HTMLStyledProps<"li"> {}
interface BreadcrumbLinkProps extends HTMLStyledProps<"a"> {
  /**
   * If `true`, change to span element.
   *
   * @default false
   */
  currentPage?: boolean;
}
declare const BreadcrumbLink: Component<"a", BreadcrumbLinkProps>;
interface BreadcrumbEllipsisProps extends HTMLStyledProps<"svg"> {}
declare const BreadcrumbEllipsis: Component<"svg", BreadcrumbEllipsisProps>;
//#endregion
export { BreadcrumbEllipsis, BreadcrumbEllipsisProps, BreadcrumbLink, BreadcrumbLinkProps, BreadcrumbPropsContext, BreadcrumbRoot, BreadcrumbRootProps, useBreadcrumbPropsContext };
//# sourceMappingURL=breadcrumb.d.ts.map