Interface BreadcrumbManagerState

A scoped and simplified part of the headless state that's relevant to the BreadcrumbManager controller.

interface BreadcrumbManagerState {
    automaticFacetBreadcrumbs: AutomaticFacetBreadcrumb[];
    categoryFacetBreadcrumbs: CategoryFacetBreadcrumb[];
    dateFacetBreadcrumbs: DateFacetBreadcrumb[];
    facetBreadcrumbs: FacetBreadcrumb[];
    hasBreadcrumbs: boolean;
    numericFacetBreadcrumbs: NumericFacetBreadcrumb[];
    staticFilterBreadcrumbs: StaticFilterBreadcrumb[];
}

Hierarchy (View Summary)

Properties

automaticFacetBreadcrumbs categoryFacetBreadcrumbs dateFacetBreadcrumbs facetBreadcrumbs hasBreadcrumbs numericFacetBreadcrumbs staticFilterBreadcrumbs

Properties

automaticFacetBreadcrumbs

automaticFacetBreadcrumbs: AutomaticFacetBreadcrumb[]

The list of automatic facet breadcrumbs.

categoryFacetBreadcrumbs

categoryFacetBreadcrumbs: CategoryFacetBreadcrumb[]

The list of category facet breadcrumbs.

dateFacetBreadcrumbs

dateFacetBreadcrumbs: DateFacetBreadcrumb[]

The list of date facet breadcrumbs.

facetBreadcrumbs

facetBreadcrumbs: FacetBreadcrumb[]

The list of specific facet breadcrumbs.

hasBreadcrumbs

hasBreadcrumbs: boolean

Returns true if there are any available breadcrumbs (i.e., if there are any active facet values), and false if not.

numericFacetBreadcrumbs

numericFacetBreadcrumbs: NumericFacetBreadcrumb[]

The list of numeric facet breadcrumbs.

staticFilterBreadcrumbs

staticFilterBreadcrumbs: StaticFilterBreadcrumb[]

The list of static filter breadcrumbs.

Settings

Member Visibility

On This Page

Properties