useRootRule

useRootRule(): object

Defined in: filter/src/hooks/use-root-rule.ts:6

Returns

object

filterableFields

filterableFields: FilterField[]

filterFnList

filterFnList: FnSchema[]

getLocaleText()

getLocaleText: (key) => string

Parameters

key

string

Returns

string

getRootRule()

getRootRule: () => FilterGroup

Deprecated

Use rootRule instead.

Returns

FilterGroup

mapFieldName()

mapFieldName: (field) => string

Parameters

field

FilterField

Returns

string

mapFilterName()

mapFilterName: (filterSchema, field) => string

Parameters

filterSchema

StandardFnSchema

field

FilterField

Returns

string

numberOfRules

numberOfRules: number

rootRule

rootRule: FilterGroup = filterRule

schema

schema: ZodType<unknown, ZodTypeDef, unknown>

setRootRule()

setRootRule: (rootGroup) => void

Parameters

rootGroup

FilterGroup

Returns

void

updateRootRule()

updateRootRule: (rootGroup) => void = setRootRule

Deprecated

Use setRootRule instead.

Parameters

rootGroup

FilterGroup

Returns

void