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

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.

Extends

• FullOption<FieldName>.BaseFullField<FieldName, OperatorName, ValueName, OperatorObj, ValueObj>

Type Parameters

Type Parameter	Default type
FieldName extends string	string
OperatorName extends string	string
ValueName extends string	string
OperatorObj extends Option	Option<OperatorName>
ValueObj extends Option	Option<ValueName>

Indexable

[key: string]: unknown

Properties

className?

optional className: Classname

Inherited from

BaseFullField.className

Defined in

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

---

comparator?

optional comparator: string | (f: FullField<string, string, string, Option<string>, Option<string>>, operator: string) => boolean

Inherited from

BaseFullField.comparator

Defined in

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

---

defaultOperator?

optional defaultOperator: OperatorName

Inherited from

BaseFullField.defaultOperator

Defined in

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

---

defaultValue?

optional defaultValue: any

Inherited from

BaseFullField.defaultValue

Defined in

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

---

disabled?

optional disabled: boolean

Inherited from

FullOption.disabled

Defined in

packages/react-querybuilder/src/types/options.ts:34

---

id?

optional id: string

Inherited from

BaseFullField.id

Defined in

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

---

inputType?

optional inputType: null | InputType

Inherited from

BaseFullField.inputType

Defined in

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

---

label

label: string

Inherited from

FullOption.label

Defined in

packages/react-querybuilder/src/types/options.ts:33

---

name

name: FieldName

Inherited from

FullOption.name

Defined in

packages/react-querybuilder/src/types/options.ts:31

---

operators?

optional operators: FlexibleOptionList<OperatorObj>

Inherited from

BaseFullField.operators

Defined in

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

---

placeholder?

optional placeholder: string

Inherited from

BaseFullField.placeholder

Defined in

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

---

validator?

optional validator: RuleValidator

Inherited from

BaseFullField.validator

Defined in

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

---

value

value: FieldName

Inherited from

FullOption.value

Defined in

packages/react-querybuilder/src/types/options.ts:32

---

valueEditorType?

optional valueEditorType: ValueEditorType | (operator: OperatorName) => ValueEditorType

Inherited from

BaseFullField.valueEditorType

Defined in

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

---

values?

optional values: FlexibleOptionList<ValueObj>

Inherited from

BaseFullField.values

Defined in

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

---

valueSources?

optional valueSources: ValueSources | (operator: OperatorName) => ValueSources

Inherited from

BaseFullField.valueSources

Defined in

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

---

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.