Interface: FullField<FieldName, OperatorName, ValueName, OperatorObj, ValueObj>
react-querybuilder.FullField
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
| Name | Type |
|---|---|
FieldName | extends string = string |
OperatorName | extends string = string |
ValueName | extends string = string |
OperatorObj | extends Option = Option<OperatorName> |
ValueObj | extends Option = Option<ValueName> |
Hierarchy
-
FullOption<FieldName> -
BaseFullField<FieldName,OperatorName,ValueName,OperatorObj,ValueObj>↳
FullField
Properties
className
Optional className: Classname
Inherited from
BaseFullField.className
Defined in
packages/react-querybuilder/src/types/basic.ts:50
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:104
defaultOperator
Optional defaultOperator: OperatorName
Inherited from
BaseFullField.defaultOperator
Defined in
packages/react-querybuilder/src/types/basic.ts:99
defaultValue
Optional defaultValue: any
Inherited from
BaseFullField.defaultValue
Defined in
packages/react-querybuilder/src/types/basic.ts:101
disabled
Optional disabled: boolean
Inherited from
Defined in
packages/react-querybuilder/src/types/options.ts:33
id
Optional id: string
Inherited from
BaseFullField.id
Defined in
packages/react-querybuilder/src/types/basic.ts:93
inputType
Optional inputType: null | InputType
Inherited from
BaseFullField.inputType
Defined in
packages/react-querybuilder/src/types/basic.ts:97
label
label: string
Inherited from
Defined in
packages/react-querybuilder/src/types/options.ts:32
name
name: FieldName
Inherited from
Defined in
packages/react-querybuilder/src/types/options.ts:30
operators
Optional operators: FlexibleOptionList<OperatorObj>
Inherited from
BaseFullField.operators
Defined in
packages/react-querybuilder/src/types/basic.ts:94
placeholder
Optional placeholder: string
Inherited from
BaseFullField.placeholder
Defined in
packages/react-querybuilder/src/types/basic.ts:102
validator
Optional validator: RuleValidator
Inherited from
BaseFullField.validator
Defined in
packages/react-querybuilder/src/types/basic.ts:103
value
value: FieldName
Inherited from
Defined in
packages/react-querybuilder/src/types/options.ts:31
valueEditorType
Optional valueEditorType: ValueEditorType | (operator: OperatorName) => ValueEditorType
Inherited from
BaseFullField.valueEditorType
Defined in
packages/react-querybuilder/src/types/basic.ts:95
valueSources
Optional valueSources: ValueSources | (operator: OperatorName) => ValueSources
Inherited from
BaseFullField.valueSources
Defined in
packages/react-querybuilder/src/types/basic.ts:96
values
Optional values: FlexibleOptionList<ValueObj>
Inherited from
BaseFullField.values