RuleGroupType<R, C>

Defined in: packages/core/src/types/ruleGroups.ts:44

The main rule group type. This type is used for query definitions as well as all sub-groups of queries.

Extends

• CommonRuleAndGroupProperties

Type Parameters

Type Parameter	Default type
R extends RuleType	RuleType
C extends string	string

Properties

combinator

combinator: C

Defined in: packages/core/src/types/ruleGroups.ts:46

---

disabled?

optional disabled: boolean

Defined in: packages/core/src/types/ruleGroups.ts:9

Inherited from

CommonRuleAndGroupProperties.disabled

---

id?

optional id: string

Defined in: packages/core/src/types/ruleGroups.ts:8

Inherited from

CommonRuleAndGroupProperties.id

---

muted?

optional muted: boolean

Defined in: packages/core/src/types/ruleGroups.ts:15

Whether this rule or group is muted. When muted, the rule or group is excluded from query export formats (SQL, JSON, MongoDB, etc.). For groups, muting recursively mutes all children.

Inherited from

CommonRuleAndGroupProperties.muted

---

not?

optional not: boolean

Defined in: packages/core/src/types/ruleGroups.ts:48

---

path?

optional path: Path

Defined in: packages/core/src/types/ruleGroups.ts:7

Inherited from

CommonRuleAndGroupProperties.path

---

rules

rules: RuleGroupArray<RuleGroupType<R, C>, R>

Defined in: packages/core/src/types/ruleGroups.ts:47

---

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.