Interface FieldSuggestions

The FieldSuggestions controller provides query suggestions based on a particular facet field.

For example, you could use this controller to provide auto-completion suggestions while the end user is typing an item title.

This controller is a wrapper around the basic facet controller search functionality, and thus exposes similar options and properties.

interface FieldSuggestions {
    state: FieldSuggestionsState;
    type: "regular";
    clear(): void;
    search(): void;
    select(value: BaseFacetSearchResult): void;
    singleSelect(value: BaseFacetSearchResult): void;
    subscribe(listener: () => void): Unsubscribe;
    updateText(text: string): void;
}

Hierarchy (View Summary)

Controller
FacetControllerType<"regular">
- FieldSuggestions

Index

Methods

clear search select singleSelect subscribe updateText

Properties

Methods

clear

clear(): void
Resets the query and empties the suggestions.

Returns void
- Defined in packages/headless/src/controllers/commerce/field-suggestions/headless-field-suggestions.ts:87

search

search(): void
Requests field suggestions based on a query.

Returns void
- Defined in packages/headless/src/controllers/commerce/field-suggestions/headless-field-suggestions.ts:64

select

select(value: BaseFacetSearchResult): void
Filters the search using the specified value.

If a facet exists with the configured facetId, selects the corresponding facet value.
Parameters
- value: BaseFacetSearchResult
  The field suggestion for which to select the matching facet value.
Returns void
- Defined in packages/headless/src/controllers/commerce/field-suggestions/headless-field-suggestions.ts:73

singleSelect

singleSelect(value: BaseFacetSearchResult): void
Filters the search using the specified value, deselecting others.

If a facet exists with the configured facetId, selects the corresponding facet value while deselecting other facet values.
Parameters
- value: BaseFacetSearchResult
  The field suggestion for which to select the matching facet value.
Returns void
- Defined in packages/headless/src/controllers/commerce/field-suggestions/headless-field-suggestions.ts:82

subscribe

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

updateText

updateText(text: string): void
Requests field suggestions based on a query.
Parameters
- text: string
  The query to search.
Returns void
- Defined in packages/headless/src/controllers/commerce/field-suggestions/headless-field-suggestions.ts:59

Properties

state

state: FieldSuggestionsState

type

type: "regular"