Skip to main content

DefaultRuleGroupTypeIC<F extends string = string>

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

RuleGroupTypeIC with combinators limited to DefaultCombinatorName and rules limited to DefaultRuleType.

Extends​

Type Parameters​

Type ParameterDefault type
F extends stringstring

Properties​

combinator?​

optional combinator?: undefined

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

Inherited from​

RuleGroupTypeIC.combinator


combinatorPreceding?​

optional combinatorPreceding?: string

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

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

Inherited from​

RuleGroupTypeIC.combinatorPreceding


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​

RuleGroupTypeIC.not


path?​

optional path?: Path

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

Inherited from​

CommonRuleAndGroupProperties.path


rules​

rules: DefaultRuleGroupICArray<F>

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

Overrides​

RuleGroupTypeIC.rules


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.