Skip to content

useFilterGroup

useFilterGroup(ruleGroup): object

Defined in: filter/src/hooks/use-filter-group.ts:12

Parameters

ruleGroup

FilterGroup

Returns

object

appendChildGroup()

appendChildGroup: (input, index) => void

Parameters

input

FilterGroupInput = ...

index

number = Infinity

Returns

void

appendChildRule()

appendChildRule: (input?, index) => void

Parameters

input?

SingleFilterInput

index?

number = Infinity

Returns

void

removeGroup()

removeGroup: () => void

Returns

void

ruleState

ruleState: object

ruleState.index

index: number = ruleIndex

ruleState.isFirstGroup

isFirstGroup: boolean

ruleState.isLastGroup

isLastGroup: boolean

ruleState.isRoot

isRoot: boolean

ruleState.depth

Get Signature

get depth(): number

Defined in: filter/src/hooks/use-filter-group.ts:131

Returns

number

toggleGroupOp()

toggleGroupOp: (op?) => void

Parameters

op?

"and" | "or"

Returns

void