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

    Interface FilterSuggestionsGeneratorAlpha

    The FilterSuggestionsGenerator controller is responsible for generating filter suggestions controllers for a given commerce engine.

    This controller relies on a Commerce API functionality that is not yet generally available. If you wish to use this feature in an implementation, please contact your Coveo representative.

    interface FilterSuggestionsGenerator {
        filterSuggestions: GeneratedFilterSuggestionsControllers;
        state: FieldSuggestionsFacet[];
        subscribe(listener: () => void): Unsubscribe;
    }

    Hierarchy (View Summary)

    Index

    Methods

    subscribe

    Properties

    filterSuggestions state

    Methods

    • Alpha

      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

    filterSuggestions: GeneratedFilterSuggestionsControllers

    The filter suggestions controllers created by the filter suggestions generator.

    state: FieldSuggestionsFacet[]

    The state of the filter suggestions generator.

    Settings

    Member Visibility

    On This Page

    Methods
    Properties