Matches

The Matches api can be accessed from finder.matches.

Type Signature

finder.matches {

    // 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 is set.
    items?: 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 is NOT set.
    groups?: FinderResultGroup<FItem>[];

    numMatchedItems: number;

    numTotalItems: number;

    hasGroupByRule: boolean;
}

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>
    })
}