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

• Data

Parameters

props

FilterSphereInput<Data>

Returns

object

context

context: FilterSchemaContext<Data>

countTotalRules()

countTotalRules: () => number

Deprecated

Use countTotalRules directly.

Returns

number

filterRule

filterRule: FilterGroup = realRule

getPredicate()

getPredicate: () => (data) => boolean

Deprecated

Use predicate directly.

Returns

Function

Parameters

data

Data

Returns

boolean

reset()

reset: (newRule) => void

Parameters

newRule

FilterGroup = defaultRule

Returns

void

predicate

Get Signature

get predicate(): (data) => boolean

Returns

Function

Parameters

data

Data

Returns

boolean

totalRuleCount

Get Signature

get totalRuleCount(): number

Returns

number

validRuleCount

Get Signature

get validRuleCount(): number

Returns

number

Example

const { predicate, context } = useFilterSphere<YourData>({ schema: yourDataSchema });
const filteredData = data.filter(predicate);