RuleGroupTypeIC<R extends RuleType = RuleType, C extends string = string>

Defined in: packages/core/src/types/ruleGroupsIC.ts:18

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

Extends

• Except<RuleGroupType<R, C>, "combinator" | "rules">

Extended by

• DefaultRuleGroupTypeIC

Type Parameters

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

Properties

combinator?

optional combinator?: undefined

Defined in: packages/core/src/types/ruleGroupsIC.ts:22

---

combinatorPreceding?

optional combinatorPreceding?: C

Defined in: packages/core/src/types/ruleGroupsIC.ts:27

Only used when adding a rule to a query that uses independent combinators

---

disabled?

optional disabled?: boolean

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

Inherited from

CommonRuleAndGroupProperties.disabled

---

id?

optional id?: string

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

Inherited from

CommonRuleAndGroupProperties.id

---

muted?

optional muted?: boolean

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

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

Inherited from

Except.not

---

path?

optional path?: Path

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

Inherited from

CommonRuleAndGroupProperties.path

---

rules

rules: RuleGroupICArray<RuleGroupTypeIC<R, C>, R, C>

Defined in: packages/core/src/types/ruleGroupsIC.ts:23

---

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.