Interface CategoryFieldSuggestions

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

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

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

Example: category-suggestions.fn.tsx

interface CategoryFieldSuggestions {
    state: CategoryFieldSuggestionsState;
    clear(): void;
    search(): void;
    select(value: CategoryFieldSuggestionsValue): void;
    showMoreResults(): void;
    subscribe(listener: () => void): Unsubscribe;
    updateCaptions(captions: Record<string, string>): void;
    updateText(text: string): void;
}

Hierarchy (View Summary)

Methods

clear search select showMoreResults subscribe updateCaptions updateText

Properties

state

Methods

clear

search

select

showMoreResults

subscribe

updateCaptions

updateText

Properties

state

state: CategoryFieldSuggestionsState

Settings

Member Visibility

On This Page

Methods
Properties