Interface BreadcrumbManager

The BreadcrumbManager headless controller manages a summary of the currently active facet filters.

Example: breadcrumb-manager.fn.tsx

interface BreadcrumbManager {
    state: BreadcrumbManagerState;
    deselectAll(): void;
    deselectBreadcrumb(value: DeselectableValue): void;
    subscribe(listener: () => void): Unsubscribe;
}

Hierarchy (View Summary)

CoreBreadcrumbManager
- BreadcrumbManager

Index

Methods

deselectAll deselectBreadcrumb subscribe

Properties

Methods

deselectAll

deselectAll(): void
Deselects all facet values.

Returns void
Inherited from CoreBreadcrumbManager.deselectAll
- Defined in packages/headless/src/controllers/core/breadcrumb-manager/headless-core-breadcrumb-manager.ts:33

deselectBreadcrumb

deselectBreadcrumb(value: DeselectableValue): void
Deselects a breadcrumb value.
Parameters
- value: DeselectableValue
  The breadcrumb value to deselect.
Returns void
Inherited from CoreBreadcrumbManager.deselectBreadcrumb
- Defined in packages/headless/src/controllers/core/breadcrumb-manager/headless-core-breadcrumb-manager.ts:39

subscribe

subscribe(listener: () => void): Unsubscribe
Adds a callback that's invoked on state change.
Parameters
- listener: () => void
  A callback that's invoked on state change.
Returns Unsubscribe
A function to remove the listener.
Inherited from CoreBreadcrumbManager.subscribe
- Defined in packages/headless/src/controllers/controller/headless-controller.ts:11

Properties

state

state: BreadcrumbManagerState

The state of the BreadcrumbManager controller.