QueryResult

sealed interface QueryResult<T>

Represents the result produced by a query.

There are two concrete types of results:

  • ExactMatch: The query matches exactly one item and should automatically be taken as the selection. If automatic selections are disabled, this type is never emitted.

  • ItemList: The query returned one or more possible matches which should be rendered in the selection dropdown. In order to do so, results of this type are exposed to the user via the ComboboxItems.results flow.

For more information refer to the official documentation.

See also

Inheritors

Types

Link copied to clipboard

Represents an exact match of an item produced by a query.

Link copied to clipboard
data class ItemList<T>(val query: String, val items: List<Combobox.Item<T>>, val truncated: Boolean) : Combobox.QueryResult<T>

Represents a list of items produced by a query that should be displayed in the selection dropdown.