Skip to main content

FullField<FieldName, OperatorName, ValueName, OperatorObj, ValueObj>

FullField<FieldName, OperatorName, ValueName, OperatorObj, ValueObj>: Simplify<FullOption<FieldName> & BaseFullField<FieldName, OperatorName, ValueName, OperatorObj, ValueObj>>

Defined in: packages/react-querybuilder/src/types/basic.ts:126

Full field definition used in the fields prop of QueryBuilder. This type requires both name and value, but the fields prop itself can use a FlexibleOption where only one of name or value is required (along with label), or Field where only name and label are required.

The name/value, operators, and values properties of this interface can be narrowed with generics.

Type Parameters

Type ParameterDefault type
FieldName extends stringstring
OperatorName extends stringstring
ValueName extends stringstring
OperatorObj extends OptionOption<OperatorName>
ValueObj extends OptionOption<ValueName>

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.