carbon-components-svelte/src/Breadcrumb/Breadcrumb.svelte.d.ts

Svelte implementation of the Carbon Design System

import { SvelteComponentTyped } from "svelte";
import type { BreadcrumbSkeletonProps } from "./BreadcrumbSkeleton.svelte";

export type BreadcrumbProps = BreadcrumbSkeletonProps & {
  /**
   * Set to `true` to hide the breadcrumb trailing slash
   * @default false
   */
  noTrailingSlash?: boolean;

  /**
   * Set to `true` to display skeleton state
   * @default false
   */
  skeleton?: boolean;

  /**
   * Specify the ARIA label for the nav
   * @default "Breadcrumb"
   */
  labelText?: string;

  /**
   * Specify the size of the breadcrumb.
   * @default "md"
   */
  size?: "sm" | "md";

  children?: (this: void) => void;
};

export default class Breadcrumb extends SvelteComponentTyped<
  BreadcrumbProps,
  {
    click: WindowEventMap["click"];
    mouseenter: WindowEventMap["mouseenter"];
    mouseleave: WindowEventMap["mouseleave"];
    mouseover: WindowEventMap["mouseover"];
  },
  { default: Record<string, never> }
> {}