Interface FacetGenerator

The FacetGenerator headless sub-controller creates commerce facet sub-controllers from the Commerce API search or product listing response.

Commerce facets are not requested by the implementer, but rather pre-configured through the Coveo Merchandising Hub (CMH). The implementer is only responsible for leveraging the facet controllers created by this sub-controller to properly render facets in their application.

interface FacetGenerator {
    facets: GeneratedFacetControllers;
    state: string[];
    deselectAll(): void;
    subscribe(listener: () => void): Unsubscribe;
}

Hierarchy (View Summary)

Controller
- FacetGenerator

Index

Methods

deselectAll subscribe

Properties

facets state

Methods

deselectAll

deselectAll(): void
Deselects all values in all facets.

Returns void
- Defined in packages/headless/src/controllers/commerce/core/facets/generator/headless-commerce-facet-generator.ts:61

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 Controller.subscribe
- Defined in packages/headless/src/controllers/controller/headless-controller.ts:11

Properties

facets

facets: GeneratedFacetControllers

The facet sub-controllers created by the facet generator. Array of RegularFacet, DateRangeFacet, NumericFacet, CategoryFacet, and LocationFacet.

state

state: string[]

The ordered list of facet IDs for which sub-controllers will be created and returned when the facets getter is called.

Interface FacetGenerator

Hierarchy (View Summary)

Index

Methods

Properties

Methods

deselectAll

Returns void

subscribe

Parameters

Returns Unsubscribe

Properties

facets

state

Settings

On This Page