Skip to main content

UseRuleGroup

UseRuleGroup: Except<RuleGroupProps, "ruleGroup"> & { accessibleDescription: string; addGroup: ActionElementEventHandler; addRule: ActionElementEventHandler; classNames: Pick<{ [k in keyof Classnames]: string }, "header" | "shiftActions" | "dragHandle" | "combinators" | "notToggle" | "addRule" | "addGroup" | "cloneGroup" | "lockGroup" | "removeGroup" | "body">; cloneGroup: ActionElementEventHandler; onCombinatorChange: ValueChangeEventHandler; onGroupAdd: (group: RuleGroupTypeAny, parentPath: Path, context?: any) => void; onIndependentCombinatorChange: (value: any, index: number, context?: any) => void; onNotToggleChange: (checked: boolean, context?: any) => void; outerClassName: string; pathsMemo: { disabled: boolean; path: Path; }[]; removeGroup: ActionElementEventHandler; ruleGroup: RuleGroupType | RuleGroupTypeIC; shiftGroupDown: (event?: MouseEvent, context?: any) => void; shiftGroupUp: (event?: MouseEvent, context?: any) => void; toggleLockGroup: ActionElementEventHandler; validationClassName: string; validationResult: boolean | ValidationResult; }

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: RuleGroupTypeAny, parentPath: Path, context?: any) => void

Parameters

ParameterType
groupRuleGroupTypeAny
parentPathPath
context?any

Returns

void

onIndependentCombinatorChange()

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

Parameters

ParameterType
valueany
indexnumber
context?any

Returns

void

onNotToggleChange()

onNotToggleChange: (checked: boolean, context?: any) => void

Parameters

ParameterType
checkedboolean
context?any

Returns

void

outerClassName

outerClassName: string

pathsMemo

pathsMemo: { disabled: boolean; path: Path; }[]

removeGroup

removeGroup: ActionElementEventHandler

ruleGroup

ruleGroup: RuleGroupType | RuleGroupTypeIC

shiftGroupDown()

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

Parameters

ParameterType
event?MouseEvent
context?any

Returns

void

shiftGroupUp()

shiftGroupUp: (event?: MouseEvent, context?: any) => 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:407


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.