Home > @vsf-enterprise/bigcommerce-theme > UseCategoryInterface > buildBreadcrumbs

UseCategoryInterface.buildBreadcrumbs() method

Builds breadcrumbs.

Signature:

buildBreadcrumbs(categoryId: number): Breadcrumb[];

Parameters

Parameter	Type	Description
categoryId	number

Returns:

Breadcrumb[]

Remarks

Breadcrumbs starts from home page and ends at a category with a passed id. If no categoryId is passed, it responds with breadcrumb for home page only.

Example

Building breadcrumbs on Category page.

import { defineComponent } from '@nuxtjs/composition-api';
import { useCategory } from '~/composables';
import { useCategoryTreeStore } from '~/stores';

export default defineComponent({
  setup() {
    const categoryTreeStore = useCategoryTreeStore();
    const { buildBreadcrumbs } = useCategory();

    const activeCategory = computed(() =>
      categoryTreeStore.flattenList.find((level) => level.url === categorySlug)
    );

    const breadcrumbs = computed(() =>
      buildBreadcrumbs(activeCategory.value?.id)
    );

    return { breadcrumbs };
  }
});