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

Methods

clear search select singleSelect subscribe updateText

Properties

state type

Methods

clear

  • clear(): void

  • Resets the query and empties the suggestions.

    Returns void

search

  • search(): void

  • Requests field suggestions based on a query.

    Returns void

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

    Returns void

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

    Returns void

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.

updateText

  • updateText(text: string): void

  • Requests field suggestions based on a query.

    Parameters

    • text: string

      The query to search.

    Returns void

Properties

state

state: FieldSuggestionsState

type

type: "regular"

Settings

Member Visibility

On This Page

Methods
Properties