Interface AutomaticFacetGenerator

The AutomaticFacetGenerator headless controller offers a high-level interface for rendering automatic facets.

Unlike regular facets that need to be explicitly defined and requested in the query, automatic facets are dynamically generated by the index in response to the query.

To learn more about the automatic facet generator feature, see: About the Facet Generator.

Examples:

interface AutomaticFacetGenerator {
state: AutomaticFacetGeneratorState;
subscribe(listener: () => void): Unsubscribe;
}

Hierarchy (View Summary)

Controller
- AutomaticFacetGenerator

Index

Methods

Properties

state

Methods

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

state

state: AutomaticFacetGeneratorState

The state of the AutomaticFacetGenerator controller.

Interface AutomaticFacetGenerator

Hierarchy (View Summary)

Index

Methods

Properties

Methods

Parameters

Returns Unsubscribe

Properties

state

Settings

On This Page