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