RuleType<F, O, V, C>

Defined in: packages/react-querybuilder/src/types/ruleGroups.ts:16

The main rule type. The field, operator, and value properties can be narrowed with generics.

Extends

• CommonRuleAndGroupProperties

Type Parameters

Type Parameter	Default type
F extends string	string
O extends string	string
V	any
C extends string	string

Properties

combinatorPreceding?

optional combinatorPreceding: C

Defined in: packages/react-querybuilder/src/types/ruleGroups.ts:30

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

---

disabled?

optional disabled: boolean

Defined in: packages/react-querybuilder/src/types/ruleGroups.ts:9

Inherited from

CommonRuleAndGroupProperties.disabled

---

field

field: F

Defined in: packages/react-querybuilder/src/types/ruleGroups.ts:23

---

id?

optional id: string

Defined in: packages/react-querybuilder/src/types/ruleGroups.ts:8

Inherited from

CommonRuleAndGroupProperties.id

---

operator

operator: O

Defined in: packages/react-querybuilder/src/types/ruleGroups.ts:24

---

path?

optional path: Path

Defined in: packages/react-querybuilder/src/types/ruleGroups.ts:7

Inherited from

CommonRuleAndGroupProperties.path

---

value

value: V

Defined in: packages/react-querybuilder/src/types/ruleGroups.ts:25

---

valueSource?

optional valueSource: ValueSource

Defined in: packages/react-querybuilder/src/types/ruleGroups.ts:26

---

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.