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.

Example: field-suggestions.fn.tsx

interface FieldSuggestions {
    state: FieldSuggestionsState;
    clear(): void;
    search(): void;
    select(value: FieldSuggestionsValue): void;
    showMoreResults(): void;
    singleSelect(value: FieldSuggestionsValue): void;
    subscribe(listener: () => void): Unsubscribe;
    updateCaptions(captions: Record<string, string>): void;
    updateText(text: string): void;
}

Hierarchy (View Summary)

Methods

clear search select showMoreResults singleSelect subscribe updateCaptions updateText

Properties

state

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: FieldSuggestionsValue): void

    Filters the search using the specified value.

    If a facet exists with the configured facetId, selects the corresponding facet value.

    Parameters

    Returns void

showMoreResults

  • showMoreResults(): void

    Shows more field suggestions for the current query.

    Returns void

singleSelect

  • singleSelect(value: FieldSuggestionsValue): 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.

updateCaptions

  • updateCaptions(captions: Record<string, string>): void

    Updates the captions of field suggestions.

    Parameters

    • captions: Record<string, string>

      A dictionary that maps field values to field suggestion display names.

    Returns void

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

Settings

Member Visibility

On This Page

Methods
Properties