@coveo/headless-react
    Preparing search index...

    Interface CoreBreadcrumbManager

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

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

    Hierarchy (View Summary)

    Index

    Methods

    • Deselects all facet values.

      Returns void

    • Deselects a breadcrumb value.

      Parameters

      Returns void

    • 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.

    Properties

    The state of the BreadcrumbManager controller.