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

    Interface QueryTrigger

    The QueryTrigger controller handles query trigger query pipeline rules, which let you define a search query to execute when a certain condition is met.

    Example: query-trigger.fn.tsx

    interface QueryTrigger {
        state: QueryTriggerState;
        subscribe(listener: () => void): Unsubscribe;
        undo(): void;
    }

    Hierarchy (View Summary)

    Index

    Methods

    Properties

    Methods

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

    • Undoes a query trigger's correction.

      Returns void

    Properties

    The state of the QueryTrigger controller.