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

search

select

showMoreResults

singleSelect

subscribe

updateCaptions

updateText

Properties

state

state: FieldSuggestionsState

Settings

Member Visibility

On This Page

Methods
Properties