Home > @shopware-pwa/composables > useBreadcrumbs

useBreadcrumbs() function

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Composable for displaying and setting breadcrumbs for page.

Signature:

export declare function useBreadcrumbs(params?: {
    hideHomeLink: boolean;
}): {
    breadcrumbs: ComputedRef<Breadcrumb[]>;
    setBreadcrumbs: (breadcrumbs: Breadcrumb[]) => void;
    clear: () => void;
};

Parameters

Parameter	Type	Description
params	{ hideHomeLink: boolean; }

Returns:

{ breadcrumbs: ComputedRef<Breadcrumb[]>; setBreadcrumbs: (breadcrumbs: Breadcrumb[]) => void; clear: () => void; }