useFilterRule
useFilterRule(
rule):object
Defined in: filter/src/hooks/use-filter-rule.ts:15
Parameters
rule
Returns
object
appendGroup()
appendGroup: (
input) =>object
Parameters
input
FilterGroupInput = ...
Returns
object
conditions
conditions:
FilterRule[] =[]
id
id:
FilterId
invert?
optionalinvert:boolean
meta?
optionalmeta:Record<string,unknown>
op
op:
"and"|"or"="and"
type
type:
"FilterGroup"="FilterGroup"
appendRule()
appendRule: (
input?) =>SingleFilter
Parameters
input?
SingleFilterInput
Returns
duplicateRule()
duplicateRule: () =>
SingleFilter
Returns
invertRule()
invertRule: (
invert?) =>void
Parameters
invert?
boolean
Returns
void
moveRule()
moveRule: (
target,index) =>void
Moves itself at specific position of Group
Parameters
target
index
number
Returns
void
removeRule()
removeRule: (
removeEmptyGroup) =>void
If removeEmptyGroup is true, remove the rule and remove empty group recursively
Note: Root group should not be removed
Parameters
removeEmptyGroup
boolean = false
Returns
void
ruleState
ruleState:
object
ruleState.index
index:
number
ruleState.isFirstRule
isFirstRule:
boolean
ruleState.isInvert
isInvert:
undefined|boolean=rule.invert
ruleState.isLastRule
isLastRule:
boolean
If the rule is the last rule in the group
ruleState.depth
Get Signature
get depth():
number
Defined in: filter/src/hooks/use-filter-rule.ts:236
Returns
number
ruleState.isValid
Get Signature
get isValid():
boolean
Defined in: filter/src/hooks/use-filter-rule.ts:228
Returns
boolean
ruleState.parentGroup
Get Signature
get parentGroup():
FilterGroup
Defined in: filter/src/hooks/use-filter-rule.ts:239
Returns
selectedField
selectedField:
undefined|FilterField
selectedFilter
selectedFilter:
undefined|StandardFnSchema
setRule()
setRule: (
input) =>void
Parameters
input
SingleFilterInput
Returns
void
updateRule()
updateRule: (
input) =>void
Parameters
input
SingleFilterInput
Returns
void