useFilterSphere
useFilterSphere<
Data>(props):object
Defined in: filter/src/hooks/use-filter-sphere.tsx:68
Provides a predicate function that can be used to filter data.
Must be used within a FilterSchemaProvider or FilterSphereProvider component.
Type Parameters
Section titled “Type Parameters”Data
Parameters
Section titled “Parameters”FilterSphereInput<Data>
Returns
Section titled “Returns”context
Section titled “context”context:
FilterSchemaContext<Data>
countTotalRules()
Section titled “countTotalRules()”countTotalRules: () =>
number
Returns
Section titled “Returns”number
filterRule
Section titled “filterRule”filterRule:
FilterGroup=realRule
getPredicate()
Section titled “getPredicate()”getPredicate: () => (
data) =>boolean
Returns
Section titled “Returns”(
data):boolean
Parameters
Section titled “Parameters”Data
Returns
Section titled “Returns”boolean
reset()
Section titled “reset()”reset: (
newRule) =>void
Parameters
Section titled “Parameters”newRule
Section titled “newRule”FilterGroup = defaultRule
Returns
Section titled “Returns”void
predicate
Section titled “predicate”Get Signature
Section titled “Get Signature”get predicate(): (
data) =>boolean
Returns
Section titled “Returns”(
data):boolean
Parameters
Section titled “Parameters”Data
Returns
Section titled “Returns”boolean
totalRuleCount
Section titled “totalRuleCount”Get Signature
Section titled “Get Signature”get totalRuleCount():
number
Returns
Section titled “Returns”number
validRuleCount
Section titled “validRuleCount”Get Signature
Section titled “Get Signature”get validRuleCount():
number
Returns
Section titled “Returns”number
Example
Section titled “Example”const { predicate, context } = useFilterSphere<YourData>({ schema: yourDataSchema });const filteredData = data.filter(predicate);