RuleGroupProps<F extends FullOption = FullOption, O extends string = string>

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

RuleGroup props.

Extends

• CommonRuleAndGroupProps<F, O>.Partial<UseRuleGroupDnD>

Extended by

• UseRuleGroup

Type Parameters

Type Parameter	Default type
F extends FullOption	FullOption
O extends string	string

Properties

actions

actions: QueryActions

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

Inherited from

CommonRuleAndGroupProps.actions

---

combinator?

optional combinator?: string

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

Deprecated

Use the combinator property of the ruleGroup prop instead

---

context?

optional context?: any

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

Inherited from

CommonRuleAndGroupProps.context

---

disabled?

optional disabled?: boolean

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

Inherited from

CommonRuleAndGroupProps.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

CommonRuleAndGroupProps.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

---

not?

optional not?: boolean

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

Deprecated

Use the not property of the ruleGroup prop instead

---

parentDisabled?

optional parentDisabled?: boolean

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

Inherited from

CommonRuleAndGroupProps.parentDisabled

---

parentMuted?

optional parentMuted?: boolean

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

Inherited from

CommonRuleAndGroupProps.parentMuted

---

path

path: Path

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

Inherited from

CommonRuleAndGroupProps.path

---

previewRef?

optional previewRef?: Ref<HTMLDivElement>

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

Inherited from

UseRuleGroupDnD.previewRef

---

ruleGroup

ruleGroup: RuleGroupTypeAny<RuleType<GetOptionIdentifierType<F>, O, any, string, Record<string, any>>>

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

---

rules?

optional rules?: RuleOrGroupArray

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

Deprecated

Use the rules property of the ruleGroup prop instead

---

schema

schema: Schema<F, O>

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

Inherited from

CommonRuleAndGroupProps.schema

---

shiftDownDisabled?

optional shiftDownDisabled?: boolean

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

Inherited from

CommonRuleAndGroupProps.shiftDownDisabled

---

shiftUpDisabled?

optional shiftUpDisabled?: boolean

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

Inherited from

CommonRuleAndGroupProps.shiftUpDisabled

---

translations

translations: Translations

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

Inherited from

CommonRuleAndGroupProps.translations

---

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.