Skip to main content

UseQueryBuilderSchema<RG, F, O, C>

UseQueryBuilderSchema<RG, F, O, C>: Pick<UseQueryBuilderSetup<RG, F, O, C>, "rqbContext"> & { actions: QueryActions; combinatorPropObject: Pick<RuleGroupProps, "combinator">; dndEnabledAttr: string; inlineCombinatorsAttr: string; queryDisabled: boolean; rootGroup: RuleGroupTypeAny<GetRuleTypeFromGroupWithFieldAndOperator<RG, F, O>>; rootGroupDisabled: boolean; schema: Schema<F, GetOptionIdentifierType<O>>; translations: TranslationsFull; wrapperClassName: string; }

Type declaration

actions

actions: QueryActions

combinatorPropObject

combinatorPropObject: Pick<RuleGroupProps, "combinator">

dndEnabledAttr

dndEnabledAttr: string

inlineCombinatorsAttr

inlineCombinatorsAttr: string

queryDisabled

queryDisabled: boolean

rootGroup

rootGroup: RuleGroupTypeAny<GetRuleTypeFromGroupWithFieldAndOperator<RG, F, O>>

rootGroupDisabled

rootGroupDisabled: boolean

schema

schema: Schema<F, GetOptionIdentifierType<O>>

translations

translations: TranslationsFull

wrapperClassName

wrapperClassName: string

Type Parameters

Type Parameter
RG extends RuleGroupTypeAny
F extends FullField
O extends FullOperator
C extends FullCombinator

Defined in

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


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.