RuleGroupProps<F, O>

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

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

Inherited from

CommonRuleAndGroupProps.actions

---

combinator?

optional combinator: string

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

Deprecated

Use the combinator property of the ruleGroup prop instead

---

context?

optional context: any

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

Inherited from

CommonRuleAndGroupProps.context

---

disabled?

optional disabled: boolean

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

Inherited from

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

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

---

not?

optional not: boolean

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

Deprecated

Use the not property of the ruleGroup prop instead

---

parentDisabled?

optional parentDisabled: boolean

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

Inherited from

CommonRuleAndGroupProps.parentDisabled

---

parentMuted?

optional parentMuted: boolean

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

Inherited from

CommonRuleAndGroupProps.parentMuted

---

path

path: Path

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

Inherited from

CommonRuleAndGroupProps.path

---

previewRef?

optional previewRef: Ref<HTMLDivElement>

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

Inherited from

UseRuleGroupDnD.previewRef

---

ruleGroup

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

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

---

rules?

optional rules: RuleOrGroupArray

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

Deprecated

Use the rules property of the ruleGroup prop instead

---

schema

schema: Schema<F, O>

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

Inherited from

CommonRuleAndGroupProps.schema

---

shiftDownDisabled?

optional shiftDownDisabled: boolean

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

Inherited from

CommonRuleAndGroupProps.shiftDownDisabled

---

shiftUpDisabled?

optional shiftUpDisabled: boolean

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

Inherited from

CommonRuleAndGroupProps.shiftUpDisabled

---

translations

translations: Translations

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

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.