android-components / mozilla.components.feature.awesomebar.provider / SearchSuggestionProvider

SearchSuggestionProvider

class SearchSuggestionProvider : SuggestionProvider (source)

A AwesomeBar.SuggestionProvider implementation that provides a suggestion containing search engine suggestions (as chips) from the passed in SearchEngine.

Constructors

<init>

SearchSuggestionProvider(searchEngine: SearchEngine, searchUseCase: DefaultSearchUrlUseCase)

A AwesomeBar.SuggestionProvider implementation that provides a suggestion containing search engine suggestions (as chips) from the passed in SearchEngine.

Properties

shouldClearSuggestions

val shouldClearSuggestions: Boolean

If true an AwesomeBar implementation can clear the previous suggestions of this provider as soon as the user continues to type. If this is false an AwesomeBar implementation is allowed to keep the previous suggestions around until the provider returns a new list of suggestions for the updated text.

Functions

onInputChanged

suspend fun onInputChanged(text: String): List<Suggestion>

Fired whenever the user changes their input, after they have started interacting with the awesome bar.

Inherited Functions

onInputCancelled

open fun onInputCancelled(): Unit

Fired when the user has cancelled their interaction with the awesome bar.

onInputStarted

open fun onInputStarted(): Unit

Fired when the user starts interacting with the awesome bar by entering text in the toolbar.