useRootRule
useRootRule():
object
Defined in: filter/src/hooks/use-root-rule.ts:6
Returns
Section titled “Returns”filterableFields
Section titled “filterableFields”filterableFields:
FilterField[]
filterFnList
Section titled “filterFnList”filterFnList:
FnSchema[]
getLocaleText
Section titled “getLocaleText”getLocaleText: (
key) =>string
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”string
getRootRule
Section titled “getRootRule”getRootRule: () =>
FilterGroup
Returns
Section titled “Returns”mapFieldName
Section titled “mapFieldName”mapFieldName: (
field) =>string
Parameters
Section titled “Parameters”Returns
Section titled “Returns”string
mapFilterName
Section titled “mapFilterName”mapFilterName: (
filterSchema,field) =>string
Parameters
Section titled “Parameters”filterSchema
Section titled “filterSchema”Returns
Section titled “Returns”string
numberOfRules
Section titled “numberOfRules”numberOfRules:
number
rootRule
Section titled “rootRule”rootRule:
FilterGroup=filterRule
schema
Section titled “schema”schema:
$ZodType<unknown,unknown,$ZodTypeInternals<unknown,unknown>>
setRootRule
Section titled “setRootRule”setRootRule: (
rootGroup) =>void
Parameters
Section titled “Parameters”rootGroup
Section titled “rootGroup”Returns
Section titled “Returns”void
updateRootRule
Section titled “updateRootRule”updateRootRule: (
rootGroup) =>void=setRootRule
Parameters
Section titled “Parameters”rootGroup
Section titled “rootGroup”Returns
Section titled “Returns”void