Skip to main content

UseRuleGroup

UseRuleGroup: Omit<RuleGroupProps, "ruleGroup"> & object

Type declaration

accessibleDescription

accessibleDescription: string

addGroup

addGroup: ActionElementEventHandler

addRule

addRule: ActionElementEventHandler

classNames

classNames: Pick<{ [k in keyof Classnames]: string }, "header" | "shiftActions" | "dragHandle" | "combinators" | "notToggle" | "addRule" | "addGroup" | "cloneGroup" | "lockGroup" | "removeGroup" | "body">

cloneGroup

cloneGroup: ActionElementEventHandler

onCombinatorChange

onCombinatorChange: ValueChangeEventHandler

onGroupAdd()

onGroupAdd: (group, parentPath, context?) => void

Parameters

ParameterType
groupRuleGroupTypeAny
parentPathPath
context?any

Returns

void

onIndependentCombinatorChange()

onIndependentCombinatorChange: (value, index, context?) => void

Parameters

ParameterType
valueany
indexnumber
context?any

Returns

void

onNotToggleChange()

onNotToggleChange: (checked, context?) => void

Parameters

ParameterType
checkedboolean
context?any

Returns

void

outerClassName

outerClassName: string

pathsMemo

pathsMemo: object[]

removeGroup

removeGroup: ActionElementEventHandler

ruleGroup

ruleGroup: RuleGroupType | RuleGroupTypeIC

shiftGroupDown()

shiftGroupDown: (event?, context?) => void

Parameters

ParameterType
event?MouseEvent
context?any

Returns

void

shiftGroupUp()

shiftGroupUp: (event?, context?) => void

Parameters

ParameterType
event?MouseEvent
context?any

Returns

void

toggleLockGroup

toggleLockGroup: ActionElementEventHandler

validationClassName

validationClassName: string

validationResult

validationResult: boolean | ValidationResult

Defined in

packages/react-querybuilder/src/components/RuleGroup.tsx:406


caution

API documentation is generated from the latest commit on the main branch. It may be somewhat inconsistent with official releases of React Query Builder.