Skip to main content

Matches

NameTypeDescription
itemsFItem[]Flat array of items that passed the search rule, all filters, have been sorted by any sortBy rules, and paginated. Will be undefined if requireGroup:true.
groupsFinderResultGroup<FItem>[]Flat array of groups that passed the search rule, all filters, have been sorted by any sortBy rules, and paginated. Will be undefined if requireGroup:false.
numMatchedItemsnumber
numTotalItemsnumberThe total number of items in the dataset.
hasGroupByRuleboolean

Example Usage

function Results() {
const finder = useFinder();
return (
<div>
Matches: {finder.matches.numMatchedItems} / {finder.matches.numTotalItems}
{finder.matches.items.map((item) => <CoolThing item={item} key={item.type} />}
</div>
})
}