useBreadcrumbs

Category:

CMS (Shopping Experiences)

Composable for breadcrumbs management. Read the guide.

It's recommended to use getCategoryBreadcrumbs for category breadcrumbs.

Types

export function useBreadcrumbs(
  newBreadcrumbs?: Breadcrumb[],
): UseBreadcrumbsReturn

source code

export type Breadcrumb = {
  name: string;
  path?: string;
};

source code

export type UseBreadcrumbsReturn = {
  /**
   * Clear breadcrumbs store
   */
  clearBreadcrumbs(): void;
  /**
   * List of breadcrumbs
   */
  breadcrumbs: ComputedRef<Breadcrumb[]>;
};

source code