Uniform Platform API

Home > @uniformdev/mesh-sdk-react > useSearchAndFilter

useSearchAndFilter() function

Search and filter hook

Signature:

useSearchAndFilter: () => {
    searchTerm: string;
    setSearchTerm: (term: string) => void;
    filterVisibility?: boolean;
    setFilterVisibility: (visible: boolean) => void;
    filters: Filter[];
    setFilters: (updatedFilters: Filter[]) => void;
    handleAddFilter: () => void;
    handleResetFilters: () => void;
    handleDeleteFilter: (index: number) => void;
    filterOptions: FilterOptionGroup[];
    validFilterQuery: Filter[] | undefined;
    filterMapper?: FilterMapper;
    totalResults?: number;
    allowBindingSearchTerm?: boolean;
}

Returns:

{ searchTerm: string; setSearchTerm: (term: string) => void; filterVisibility?: boolean; setFilterVisibility: (visible: boolean) => void; filters: Filter; totalResults?: number; allowBindingSearchTerm?: boolean; }

Example

const { searchTerm, setSearchTerm, filterVisibility, setFilterVisibility, filters, setFilters, handleAddFilter, handleResetFilters, handleDeleteFilter, filterOptions, validFilterQuery } = useSearchAndFilter();