Skip to main content

useQueryBuilder()

useQueryBuilder<RG, F, O, C>(props: QueryBuilderProps<RG, F, O, C>): UseQueryBuilderSchema<RG, F, O, C>

Calls useQueryBuilderSetup to massage the props and prepare basic update/generate methods, then passes the result to useQueryBuilderSchema to prepare and return all values required to render QueryBuilder.

Type Parameters​

Type Parameter
RG extends RuleGroupTypeAny
F extends FullField<string, string, string, Option<string>, Option<string>>
O extends FullOperator<string>
C extends FullCombinator<string>

Parameters​

ParameterType
propsQueryBuilderProps<RG, F, O, C>

Returns​

UseQueryBuilderSchema<RG, F, O, C>

Defined in​

packages/react-querybuilder/src/components/QueryBuilder.useQueryBuilder.ts:17

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.