Home > @findkit/ui > GroupResults
GroupResults interface
Type for groupped search results.
Signature:
export interface GroupResults
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| active | boolean | Whether searches are actively made to this group. This is true for all groups in the initial multi group view but only for the selected group in the single group view | |
| groupDefinition | GroupDefinition | DEPRECATED | |
| hits | ReadonlyArray<SearchResultHit> | Search hits for this group | |
| id | string | The group id | |
| previewSize | number | How many results are shown on the initial groupped view | |
| relevancyBoost | number | The group's relevancyBoost value https://docs.findkit.com/ui/api/groups#relevancyBoost | |
| results | EngineResultGroup | DEPRECATED | |
| title | string | Group title | |
| total | number | Total search results for this group |