UseQueryBuilderSetup<RG, F, O, C>
UseQueryBuilderSetup<
RG
,F
,O
,C
>:object
&RemoveNullability
<object
> &object
Type declaration
combinators
combinators:
WithUnknownIndex
<BaseOption
<string
> &FullOption
<string
>>[] |OptionGroup
<WithUnknownIndex
<BaseOption
<string
> &FullOption
<string
>>>[]
createRule()
createRule: () =>
GetRuleTypeFromGroupWithFieldAndOperator
<RG
,F
,O
>
Returns
GetRuleTypeFromGroupWithFieldAndOperator
<RG
, F
, O
>
createRuleGroup()
createRuleGroup: (
independentCombinators
?) =>RG
Parameters
Parameter | Type |
---|---|
independentCombinators ? | boolean |
Returns
RG
fieldMap
fieldMap:
FullOptionMap
<FullField
<string
,string
,string
,Option
<string
>,Option
<string
>>,GetOptionIdentifierType
<F
>>
fields
fields:
FullOptionList
<F
>
getRuleDefaultValue()
getRuleDefaultValue: <
RT
>(r
) =>any
Type Parameters
Type Parameter | Default type |
---|---|
RT extends RuleType | GetRuleTypeFromGroupWithFieldAndOperator <RG , F , O > |
Parameters
Parameter | Type |
---|---|
r | RT |
Returns
any
qbId
qbId:
string
rqbContext
rqbContext:
UseMergedContextReturn
<F
,GetOptionIdentifierType
<O
>>
Type declaration
getOperatorsMain()
getOperatorsMain: (...
p
) =>FullOptionList
<O
>
Parameters
Parameter | Type |
---|---|
...p | Parameters <NonNullable <QueryBuilderProps <RG , F , O , C >["getOperators" ]>> |
Returns
getValuesMain()
getValuesMain: (...
p
) =>FullOptionList
<Option
>
Parameters
Parameter | Type |
---|---|
...p | Parameters <NonNullable <QueryBuilderProps <RG , F , O , C >["getValues" ]>> |
Returns
Type Parameters
Type Parameter |
---|
RG extends RuleGroupTypeAny |
F extends FullField |
O extends FullOperator |
C extends FullCombinator |
Defined in
packages/react-querybuilder/src/components/QueryBuilder.useQueryBuilderSetup.ts:59
API documentation is generated from the latest commit on the main
branch. It may be somewhat inconsistent with official releases of React Query Builder.