FieldByValue<FieldName, OperatorName, ValueName, OperatorObj>
FieldByValue<
FieldName
,OperatorName
,ValueName
,OperatorObj
>:WithUnknownIndex
<{name
:FieldName
; } &Pick
<BaseFullField
<FieldName
,OperatorName
,ValueName
,OperatorObj
>,Exclude
<keyofBaseFullField
,"name"
>>>
Field definition used in the fields
prop of QueryBuilder.
This type is an extension of FullField where only value
and
label
are required.
The name
/value
, operators
, and values
properties of this interface
can be narrowed with generics.
Type Parameters
Type Parameter | Default type |
---|---|
FieldName extends string | string |
OperatorName extends string | string |
ValueName extends string | string |
OperatorObj extends Option | Option <OperatorName > |
Defined in
packages/react-querybuilder/src/types/basic.ts:166
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.