UseRuleGroup

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

RuleGroup props.

Extends

• RuleGroupProps

Properties

accessibleDescription

accessibleDescription: string

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

---

actions

actions: QueryActions

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

Inherited from

RuleGroupProps.actions

---

addGroup

addGroup: ActionElementEventHandler

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

---

addRule

addRule: ActionElementEventHandler

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

---

classNames

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

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

---

cloneGroup

cloneGroup: ActionElementEventHandler

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

---

combinator?

optional combinator: string

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

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:643

Inherited from

RuleGroupProps.context

---

disabled?

optional disabled: boolean

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

Inherited from

RuleGroupProps.disabled

---

dragMonitorId?

optional dragMonitorId: string | symbol

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

Inherited from

UseRuleGroupDnD.dragMonitorId

---

dragRef?

optional dragRef: Ref<HTMLSpanElement>

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

Inherited from

UseRuleGroupDnD.dragRef

---

dropEffect?

optional dropEffect: DropEffect

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

"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:653

Inherited from

UseRuleGroupDnD.dropMonitorId

---

dropNotAllowed?

optional dropNotAllowed: boolean

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

Inherited from

UseRuleGroupDnD.dropNotAllowed

---

dropRef?

optional dropRef: Ref<HTMLDivElement>

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

Inherited from

UseRuleGroupDnD.dropRef

---

groupItems?

optional groupItems: boolean

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

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:632

Inherited from

RuleGroupProps.id

---

isDragging?

optional isDragging: boolean

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

Inherited from

UseRuleGroupDnD.isDragging

---

isOver?

optional isOver: boolean

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

Inherited from

UseRuleGroupDnD.isOver

---

muted?

optional muted: boolean

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

---

not?

optional not: boolean

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

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:447

---

onGroupAdd()

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

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

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:449

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:450

Parameters

Parameter	Type
checked	boolean
context?	any

Returns

void

---

outerClassName

outerClassName: string

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

---

parentDisabled?

optional parentDisabled: boolean

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

Inherited from

RuleGroupProps.parentDisabled

---

parentMuted?

optional parentMuted: boolean

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

Inherited from

RuleGroupProps.parentMuted

---

path

path: Path

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

Inherited from

RuleGroupProps.path

---

pathsMemo

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

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

disabled

disabled: boolean

path

path: Path

---

previewRef?

optional previewRef: Ref<HTMLDivElement>

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

Inherited from

UseRuleGroupDnD.previewRef

---

removeGroup

removeGroup: ActionElementEventHandler

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

---

ruleGroup

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

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

Overrides

RuleGroupProps.ruleGroup

---

rules?

optional rules: RuleOrGroupArray

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

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:637

Inherited from

RuleGroupProps.schema

---

shiftDownDisabled?

optional shiftDownDisabled: boolean

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

Inherited from

RuleGroupProps.shiftDownDisabled

---

shiftGroupDown()

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

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

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:456

Parameters

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

Returns

void

---

shiftUpDisabled?

optional shiftUpDisabled: boolean

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

Inherited from

RuleGroupProps.shiftUpDisabled

---

toggleLockGroup

toggleLockGroup: ActionElementEventHandler

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

---

toggleMuteGroup

toggleMuteGroup: ActionElementEventHandler

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

---

translations

translations: Translations

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

Inherited from

RuleGroupProps.translations

---

validationClassName

validationClassName: string

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

---

validationResult

validationResult: boolean | ValidationResult

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

---

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.