UseRuleGroup

Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:483

RuleGroup props.

Extends

• RuleGroupProps

Properties

accessibleDescription

accessibleDescription: string

Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:486

---

actions

actions: QueryActions

Defined in: packages/react-querybuilder/src/types/props.ts:728

Inherited from

RuleGroupProps.actions

---

addGroup

addGroup: ActionElementEventHandler

Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:484

---

addRule

addRule: ActionElementEventHandler

Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:485

---

classNames

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

Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:488

---

cloneGroup

cloneGroup: ActionElementEventHandler

Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:507

---

combinator?

optional combinator?: string

Defined in: packages/react-querybuilder/src/types/props.ts:767

Deprecated

Use the combinator property of the ruleGroup prop instead

Inherited from

RuleGroupProps.combinator

---

context?

optional context?: any

Defined in: packages/react-querybuilder/src/types/props.ts:733

Inherited from

RuleGroupProps.context

---

disabled?

optional disabled?: boolean

Defined in: packages/react-querybuilder/src/types/props.ts:729

Inherited from

RuleGroupProps.disabled

---

dragHandleAttributes?

optional dragHandleAttributes?: HTMLAttributes<HTMLElement>

Defined in: packages/react-querybuilder/src/types/props.ts:748

Props to spread onto the drag handle element (ARIA attributes, listeners).

Inherited from

UseRuleGroupDnD.dragHandleAttributes

---

dragMonitorId?

optional dragMonitorId?: string | symbol

Defined in: packages/react-querybuilder/src/types/props.ts:741

Inherited from

UseRuleGroupDnD.dragMonitorId

---

dragRef?

optional dragRef?: Ref<HTMLSpanElement>

Defined in: packages/react-querybuilder/src/types/props.ts:745

Inherited from

UseRuleGroupDnD.dragRef

---

dropEffect?

optional dropEffect?: DropEffect

Defined in: packages/react-querybuilder/src/types/props.ts:750

"move" by default; "copy" if the modifier key is pressed.

Inherited from

UseRuleGroupDnD.dropEffect

---

dropMonitorId?

optional dropMonitorId?: string | symbol

Defined in: packages/react-querybuilder/src/types/props.ts:743

Inherited from

UseRuleGroupDnD.dropMonitorId

---

dropNotAllowed?

optional dropNotAllowed?: boolean

Defined in: packages/react-querybuilder/src/types/props.ts:753

Inherited from

UseRuleGroupDnD.dropNotAllowed

---

dropRef?

optional dropRef?: Ref<HTMLDivElement>

Defined in: packages/react-querybuilder/src/types/props.ts:746

Inherited from

UseRuleGroupDnD.dropRef

---

groupItems?

optional groupItems?: boolean

Defined in: packages/react-querybuilder/src/types/props.ts:752

True if the dragged and hovered items should form a new group.

Inherited from

UseRuleGroupDnD.groupItems

---

id?

optional id?: string

Defined in: packages/react-querybuilder/src/types/props.ts:722

Inherited from

RuleGroupProps.id

---

isDragging?

optional isDragging?: boolean

Defined in: packages/react-querybuilder/src/types/props.ts:740

Inherited from

UseRuleGroupDnD.isDragging

---

isOver?

optional isOver?: boolean

Defined in: packages/react-querybuilder/src/types/props.ts:742

Inherited from

UseRuleGroupDnD.isOver

---

muted?

optional muted?: boolean

Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:487

---

not?

optional not?: boolean

Defined in: packages/react-querybuilder/src/types/props.ts:775

Deprecated

Use the not property of the ruleGroup prop instead

Inherited from

RuleGroupProps.not

---

onCombinatorChange

onCombinatorChange: ValueChangeEventHandler

Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:509

---

onGroupAdd

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

Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:510

Parameters

Parameter	Type
group	RuleGroupTypeAny
parentPath	Path
context?	any

Returns

void

---

onIndependentCombinatorChange

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

Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:511

Parameters

Parameter	Type
value	any
index	number
context?	any

Returns

void

---

onNotToggleChange

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

Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:512

Parameters

Parameter	Type
checked	boolean
context?	any

Returns

void

---

outerClassName

outerClassName: string

Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:513

---

parentDisabled?

optional parentDisabled?: boolean

Defined in: packages/react-querybuilder/src/types/props.ts:724

Inherited from

RuleGroupProps.parentDisabled

---

parentMuted?

optional parentMuted?: boolean

Defined in: packages/react-querybuilder/src/types/props.ts:725

Inherited from

RuleGroupProps.parentMuted

---

path

path: Path

Defined in: packages/react-querybuilder/src/types/props.ts:723

Inherited from

RuleGroupProps.path

---

pathsMemo

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

Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:514

disabled

disabled: boolean

path

path: Path

---

previewRef?

optional previewRef?: Ref<HTMLDivElement>

Defined in: packages/react-querybuilder/src/types/props.ts:744

Inherited from

UseRuleGroupDnD.previewRef

---

removeGroup

removeGroup: ActionElementEventHandler

Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:515

---

ruleGroup

ruleGroup: RuleGroupType<RuleType<string, string, any, string, Record<string, any>>, string> | RuleGroupTypeIC<RuleType<string, string, any, string, Record<string, any>>, string>

Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:516

Overrides

RuleGroupProps.ruleGroup

---

rules?

optional rules?: RuleOrGroupArray

Defined in: packages/react-querybuilder/src/types/props.ts:771

Deprecated

Use the rules property of the ruleGroup prop instead

Inherited from

RuleGroupProps.rules

---

schema

schema: Schema<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }, string>

Defined in: packages/react-querybuilder/src/types/props.ts:727

Inherited from

RuleGroupProps.schema

---

shiftDownDisabled?

optional shiftDownDisabled?: boolean

Defined in: packages/react-querybuilder/src/types/props.ts:731

Inherited from

RuleGroupProps.shiftDownDisabled

---

shiftGroupDown

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

Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:517

Parameters

Parameter	Type
event?	MouseEvent<Element, MouseEvent>
context?	any

Returns

void

---

shiftGroupUp

shiftGroupUp: (event?: MouseEvent<Element, MouseEvent>, context?: any) => void

Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:518

Parameters

Parameter	Type
event?	MouseEvent<Element, MouseEvent>
context?	any

Returns

void

---

shiftUpDisabled?

optional shiftUpDisabled?: boolean

Defined in: packages/react-querybuilder/src/types/props.ts:730

Inherited from

RuleGroupProps.shiftUpDisabled

---

toggleLockGroup

toggleLockGroup: ActionElementEventHandler

Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:519

---

toggleMuteGroup

toggleMuteGroup: ActionElementEventHandler

Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:520

---

translations

translations: Translations

Defined in: packages/react-querybuilder/src/types/props.ts:726

Inherited from

RuleGroupProps.translations

---

ungroup

ungroup: ActionElementEventHandler

Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:508

---

validationClassName

validationClassName: string

Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:521

---

validationResult

validationResult: boolean | ValidationResult

Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:522

---

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.