Skip to main content

FieldByValue<FieldName, OperatorName, ValueName, OperatorObj>

FieldByValue<FieldName, OperatorName, ValueName, OperatorObj>: WithUnknownIndex<object & Pick<BaseFullField<FieldName, OperatorName, ValueName, OperatorObj>, Exclude<keyof BaseFullField, "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 ParameterDefault type
FieldName extends stringstring
OperatorName extends stringstring
ValueName extends stringstring
OperatorObj extends OptionOption<OperatorName>

Defined in

packages/react-querybuilder/src/types/basic.ts:153


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.