useQueryBuilderSchema()
useQueryBuilderSchema<
RG,F,O,C>(props,setup):QueryBuilderProps<RG,F,O,C> &object
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
| Parameter | Type |
|---|---|
props | QueryBuilderProps<RG, F, O, C> |
setup | object |
setup.combinators | WithUnknownIndex <BaseOption<string> & FullOption<string>>[] | OptionGroup <WithUnknownIndex <BaseOption<string> & FullOption<string>>>[] |
setup.createRule | () => GetRuleTypeFromGroupWithFieldAndOperator<RG, F, O> |
setup.createRuleGroup | (independentCombinators?) => RG |
setup.fieldMap | FullOptionMap <FullField<string, string, string, Option<string>, Option<string>>, GetOptionIdentifierType<F>> |
setup.fields | FullOptionList<F> |
setup.getInputTypeMain | (field, operator, __namedParameters) => InputType |
setup.getOperatorsMain | (field, __namedParameters) => FullOptionList<O> |
setup.getRuleDefaultOperator | (field) => GetOptionIdentifierType<O> |
setup.getRuleDefaultValue | <RT>(r) => any |
setup.getValueEditorTypeMain | (field, operator, __namedParameters) => ValueEditorType |
setup.getValueSourcesMain | (field, operator) => ValueSources |
setup.getValuesMain | (field, operator, __namedParameters) => WithUnknownIndex <BaseOption<string> & FullOption<string>>[] | OptionGroup <WithUnknownIndex <BaseOption<string> & FullOption<string>>>[] |
setup.qbId | string |
setup.rqbContext | object |
setup.rqbContext.controlClassnames | Classnames |
setup.rqbContext.controlElements | Controls<F, GetOptionIdentifierType<O>> |
setup.rqbContext.debugMode | boolean |
setup.rqbContext.enableDragAndDrop | boolean |
setup.rqbContext.enableMountQueryChange | boolean |
setup.rqbContext.translations | TranslationsFull |
Returns
QueryBuilderProps<RG, F, O, C> & object
Source
packages/react-querybuilder/src/hooks/useQueryBuilderSchema.ts:64
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.