Skip to main content

useQueryBuilderSchema()

useQueryBuilderSchema<RG, F, O, C>(props, setup): UseQueryBuilderSchema<RG, F, O, C>

For given QueryBuilderProps and setup values from useQueryBuilderSetup, prepares and returns all values required to render a query builder.

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>
setupUseQueryBuilderSetup<RG, F, O, C>

Returns​

UseQueryBuilderSchema<RG, F, O, C>

Defined in​

packages/react-querybuilder/src/components/QueryBuilder.useQueryBuilderSchema.ts:80

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.