(Deprecated) BreadcrumbManager
(Deprecated) BreadcrumbManager
The BreadcrumbManager
headless controller manages a summary of the currently active facet filters.
Methods
hasBreadcrumbs
Whether there are any available breadcrumbs (that is, if there are any active facet values).
Returns boolean
deselectAll
Deselects all facet values.
subscribe
Adds a callback that will be called on state change.
Parameters
-
listener:
() ⇒ void
A callback to be invoked on state change.
Returns Unsubscribe
: An unsubscribe function to remove the listener.
Attributes
state
The state of the BreadcrumbManager
controller.
Properties
-
categoryFacetBreadcrumbs:
CategoryFacetBreadcrumb[]
The list of category facet breadcrumbs.
-
dateFacetBreadcrumbs:
Breadcrumb<DateFacetValue>
The list of date facet breadcrumbs.
-
facetBreadcrumbs:
Breadcrumb<FacetValue>
The list of specific facet breadcrumbs.
-
numericFacetBreadcrumbs:
Breadcrumb<NumericFacetValue>
The list of numeric facet breadcrumbs.
Initialize
buildBreadcrumbManager
Creates a BreadcrumbManager
controller instance.
Parameters
-
engine:
Engine<ConfigurationSection & SearchSection & FacetSection & NumericFacetSection & DateFacetSection & CategoryFacetSection>
The headless engine.
Returns BreadcrumbManager
Related Types
CategoryFacetBreadcrumb
Properties
-
deselect:
() ⇒ void
Deselects the corresponding facet value.
-
facetId:
string
The id for the underlying facet.
-
field:
string
The field on which the underlying facet is configured.
-
path:
CategoryFacetValue[]
The complete path of the underlying category facet value.
CategoryFacetValue
Properties
-
children:
CategoryFacetValue[]
The children of this facet value.
-
moreValuesAvailable:
boolean
Whether more values are available.
-
numberOfResults:
number
The number of results having the facet value.
-
path:
string[]
The hierarchical path to the facet value.
-
state:
'idle' | 'selected'
Whether a facet value is filtering results (
selected
) or not (idle
). -
value:
string
The facet value.
Unsubscribe
Call signatures
-
(): void