Skip to main content

useQueryBuilderSetup()

useQueryBuilderSetup<RG, F, O, C>(props: QueryBuilderProps<RG, F, O, C>): UseQueryBuilderSetup<RG, F, O, C>

Massages the props as necessary and prepares the basic update/generate methods for use by the QueryBuilder component.

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​

UseQueryBuilderSetup<RG, F, O, C>

Defined in​

packages/react-querybuilder/src/components/QueryBuilder.useQueryBuilderSetup.ts:98

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.