UseQueryBuilderSetup<RG extends RuleGroupTypeAny, F extends FullField, O extends FullOperator, C extends FullCombinator>

UseQueryBuilderSetup<RG extends RuleGroupTypeAny, F extends FullField, O extends FullOperator, C extends FullCombinator> = { combinators: WithUnknownIndex<BaseOption & FullOption>[] | OptionGroup<WithUnknownIndex<BaseOption & FullOption>>[]; createRule: () => GetRuleTypeFromGroupWithFieldAndOperator<RG, F, O>; createRuleGroup: (independentCombinators?: boolean) => RG; fieldMap: FullOptionMap<FullField<string, string, string, FullOption, FullOption>, GetOptionIdentifierType<F>>; fields: FullOptionList<F>; getRuleDefaultValue: <RT>(r: RT) => any; qbId: string; resolveQbIdCollision: () => void; rqbContext: UseMergedContext<F, GetOptionIdentifierType<O>, true>; getParameters: {[key: string]: unknown; disabled?: boolean; label: string; name: N; value: N; }[] | OptionGroup<{[key: string]: unknown; disabled?: boolean; label: string; name: N; value: N; }>[]; } & RemoveNullability<{ getInputTypeMain: QueryBuilderProps<RG, F, O, C>["getInputType"]; getRuleDefaultOperator: QueryBuilderProps<RG, F, O, C>["getDefaultOperator"]; getValueEditorTypeMain: QueryBuilderProps<RG, F, O, C>["getValueEditorType"]; }> & { getMatchModesMain: (field: GetOptionIdentifierType<F>, misc?: { fieldData: F; }) => MatchModeOptions; getOperatorsMain: (...p: Parameters<NonNullable<QueryBuilderProps<RG, F, O, C>["getOperators"]>>) => FullOptionList<O>; getSubQueryBuilderPropsMain: (field: GetOptionIdentifierType<F>, misc: { fieldData: F; }) => Record<string, unknown>; getValuesMain: (...p: Parameters<NonNullable<QueryBuilderProps<RG, F, O, C>["getValues"]>>) => FullOptionList<Option>; getValueSourcesMain: (field: GetOptionIdentifierType<F>, operator: GetOptionIdentifierType<O>, misc: { fieldData: F; }) => ValueSourceFullOptions; }

Defined in: packages/react-querybuilder/src/components/QueryBuilder.useQueryBuilderSetup.ts:43

Type Declaration

combinators

combinators: WithUnknownIndex<BaseOption & FullOption>[] | OptionGroup<WithUnknownIndex<BaseOption & FullOption>>[]

createRule

createRule: () => GetRuleTypeFromGroupWithFieldAndOperator<RG, F, O>

Returns

GetRuleTypeFromGroupWithFieldAndOperator<RG, F, O>

createRuleGroup

createRuleGroup: (independentCombinators?: boolean) => RG

Parameters

Parameter	Type
independentCombinators?	boolean

Returns

RG

fieldMap

fieldMap: FullOptionMap<FullField<string, string, string, FullOption, FullOption>, GetOptionIdentifierType<F>>

fields

fields: FullOptionList<F>

getRuleDefaultValue

getRuleDefaultValue: <RT>(r: RT) => any

Type Parameters

Type Parameter	Default type
RT extends RuleType	GetRuleTypeFromGroupWithFieldAndOperator<RG, F, O>

Parameters

Parameter	Type
r	RT

Returns

any

qbId

qbId: string

resolveQbIdCollision

resolveQbIdCollision: () => void

Returns

void

rqbContext

rqbContext: UseMergedContext<F, GetOptionIdentifierType<O>, true>

getParameters()

getParameters(field?: GetOptionIdentifierType<F>, operator?: GetOptionIdentifierType<O>, meta?: { fieldData: F; }): {[key: string]: unknown; disabled?: boolean; label: string; name: N; value: N; }[] | OptionGroup<{[key: string]: unknown; disabled?: boolean; label: string; name: N; value: N; }>[]

Parameters

Parameter	Type
field?	GetOptionIdentifierType<F>
operator?	GetOptionIdentifierType<O>
meta?	{ fieldData: F; }
meta.fieldData?	F

Returns

{[key: string]: unknown; disabled?: boolean; label: string; name: N; value: N; }[] | OptionGroup<{[key: string]: unknown; disabled?: boolean; label: string; name: N; value: N; }>[]

Type Declaration

getMatchModesMain

getMatchModesMain: (field: GetOptionIdentifierType<F>, misc?: { fieldData: F; }) => MatchModeOptions

Parameters

Parameter	Type
field	GetOptionIdentifierType<F>
misc?	{ fieldData: F; }
misc.fieldData?	F

Returns

MatchModeOptions

getOperatorsMain

getOperatorsMain: (...p: Parameters<NonNullable<QueryBuilderProps<RG, F, O, C>["getOperators"]>>) => FullOptionList<O>

Parameters

Parameter	Type
...p	Parameters<NonNullable<QueryBuilderProps<RG, F, O, C>["getOperators"]>>

Returns

FullOptionList<O>

getSubQueryBuilderPropsMain

getSubQueryBuilderPropsMain: (field: GetOptionIdentifierType<F>, misc: { fieldData: F; }) => Record<string, unknown>

Parameters

Parameter	Type
field	GetOptionIdentifierType<F>
misc	{ fieldData: F; }
misc.fieldData	F

Returns

Record<string, unknown>

getValuesMain

getValuesMain: (...p: Parameters<NonNullable<QueryBuilderProps<RG, F, O, C>["getValues"]>>) => FullOptionList<Option>

Parameters

Parameter	Type
...p	Parameters<NonNullable<QueryBuilderProps<RG, F, O, C>["getValues"]>>

Returns

FullOptionList<Option>

getValueSourcesMain

getValueSourcesMain: (field: GetOptionIdentifierType<F>, operator: GetOptionIdentifierType<O>, misc: { fieldData: F; }) => ValueSourceFullOptions

Parameters

Parameter	Type
field	GetOptionIdentifierType<F>
operator	GetOptionIdentifierType<O>
misc	{ fieldData: F; }
misc.fieldData	F

Returns

ValueSourceFullOptions

Type Parameters

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

---

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.