QueryBuilderProps<RG, F, O, C>

QueryBuilderProps<RG, F, O, C>: RG extends RuleGroupType<infer R> | RuleGroupTypeIC<infer R> ? QueryBuilderContextProps<F, GetOptionIdentifierType<O>> & object : never

Props for QueryBuilder.

Notes:

• Only one of query or defaultQuery should be provided. If query is present, then defaultQuery should be undefined and vice versa.
• If rendered initially with a query prop, then query must be defined in every subsequent render or warnings will be logged (in non-production modes only).

Type Parameters

Type Parameter	Description
RG extends RuleGroupTypeAny	The type of the query object, inferred from either the query or defaultQuery prop. Must extend RuleGroupType or RuleGroupTypeIC.
F extends FullField	The field type (see Field).
O extends FullOperator	The operator type (see Operator).
C extends FullCombinator	The combinator type (see Combinator).

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:535

---

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.