useBreadcrumbs ​

Definition ​

Composable for breadcrumbs management. Read the guide.

It's recommended to use getCategoryBreadcrumbs for category breadcrumbs.

Basic usage ​

const {  breadcrumbs, clearBreadcrumbs } = useBreadcrumbs(newBreadcrumbs);

Signature ​

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

Parameters ​

Array<Breadcrumb>

Return type ​

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

Properties ​

ComputedRef<Array<Breadcrumb>>

Methods ​

void

Usage ​

<script setup lang="ts">
useBreadcrumbs([
  {
    name: "Home",
    path: "/",
  },
  {
    name: "Top sellers",
    path: "/top-sellers",
  },
]);
</script>