filterFieldsByComparator()
filterFieldsByComparator(
field
: {[key
:string
]:unknown
;className?
:Classname
;comparator?
:string
| (f
: {[key
:string
]:unknown
;className?
:Classname
;comparator?
: string | ((f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (string...;defaultOperator?
:string
;defaultValue?
:any
;disabled?
:boolean
;id?
:string
;inputType?
:null
|InputType
;label
:string
;matchModes?
:boolean
|MatchMode
[] |FlexibleOption
<MatchMode
>[];name
:string
;operators?
:string
[] |FlexibleOptionList
<{[key
:string
]:unknown
;disabled?
:boolean
;label
:string
;name
:string
;value
:string
; }> |FlexibleOption
<string
>[] | string | FlexibleOption<string>[];placeholder?
:string
;subproperties?
:FlexibleOptionList
<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (string | FlexibleOpt...>;validator?
:RuleValidator
;value
:string
;valueEditorType?
:ValueEditorType
| (operator
:string
) =>ValueEditorType
;values?
:FlexibleOptionList
<{[key
:string
]:unknown
;disabled?
:boolean
;label
:string
;name
:string
;value
:string
; }>;valueSources?
:ValueSources
|ValueSourceFlexibleOptions
| (operator
:string
) => ValueSources | ValueSourceFlexibleOptions; },operator
:string
) =>boolean
;defaultOperator?
:string
;defaultValue?
:any
;disabled?
:boolean
;id?
:string
;inputType?
:null
|InputType
;label
:string
;matchModes?
:boolean
|MatchMode
[] |FlexibleOption
<MatchMode
>[];name
:string
;operators?
:string
[] |FlexibleOptionList
<{[key
:string
]:unknown
;disabled?
:boolean
;label
:string
;name
:string
;value
:string
; }> |FlexibleOption
<string
>[] | string | FlexibleOption<string>[];placeholder?
:string
;subproperties?
:FlexibleOptionList
<{[key
:string
]:unknown
;className?
: Classname | undefined;comparator?
:string
| (f
: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (string | FlexibleOpt...,operator
:string
) =>boolean
;defaultOperator?
:string
;defaultValue?
:any
;disabled?
:boolean
;id?
:string
;inputType?
: InputType | null | undefined;label
:string
;matchModes?
:boolean
|MatchMode
[] |FlexibleOption
<MatchMode
>[];name
:string
;operators?
: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<string>[] | (string | FlexibleOption<...>)[] | undefined;placeholder?
:string
;subproperties?
: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (s...;validator?
:RuleValidator
;value
:string
;valueEditorType?
: ValueEditorType | ((operator: string) => ValueEditorType) | undefined;values?
: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | undefined;valueSources?
: ValueSources | ValueSourceFlexibleOptions | ((operator: string) => ValueSources | ValueSourceFlexibleOptions) | undefined; }>;validator?
:RuleValidator
;value
:string
;valueEditorType?
:ValueEditorType
| (operator
:string
) =>ValueEditorType
;values?
:FlexibleOptionList
<{[key
:string
]:unknown
;disabled?
:boolean
;label
:string
;name
:string
;value
:string
; }>;valueSources?
:ValueSources
|ValueSourceFlexibleOptions
| (operator
:string
) => ValueSources | ValueSourceFlexibleOptions; },fields
:OptionList
<{[key
:string
]:unknown
;className?
:Classname
;comparator?
:string
| (f
: {[key
:string
]:unknown
;className?
:Classname
;comparator?
: string | ((f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (string...;defaultOperator?
:string
;defaultValue?
:any
;disabled?
:boolean
;id?
:string
;inputType?
:null
|InputType
;label
:string
;matchModes?
:boolean
|MatchMode
[] |FlexibleOption
<MatchMode
>[];name
:string
;operators?
:string
[] |FlexibleOptionList
<{[key
:string
]:unknown
;disabled?
:boolean
;label
:string
;name
:string
;value
:string
; }> |FlexibleOption
<string
>[] | string | FlexibleOption<string>[];placeholder?
:string
;subproperties?
:FlexibleOptionList
<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (string | FlexibleOpt...>;validator?
:RuleValidator
;value
:string
;valueEditorType?
:ValueEditorType
| (operator
:string
) =>ValueEditorType
;values?
:FlexibleOptionList
<{[key
:string
]:unknown
;disabled?
:boolean
;label
:string
;name
:string
;value
:string
; }>;valueSources?
:ValueSources
|ValueSourceFlexibleOptions
| (operator
:string
) => ValueSources | ValueSourceFlexibleOptions; },operator
:string
) =>boolean
;defaultOperator?
:string
;defaultValue?
:any
;disabled?
:boolean
;id?
:string
;inputType?
:null
|InputType
;label
:string
;matchModes?
:boolean
|MatchMode
[] |FlexibleOption
<MatchMode
>[];name
:string
;operators?
:string
[] |FlexibleOptionList
<{[key
:string
]:unknown
;disabled?
:boolean
;label
:string
;name
:string
;value
:string
; }> |FlexibleOption
<string
>[] | string | FlexibleOption<string>[];placeholder?
:string
;subproperties?
:FlexibleOptionList
<{[key
:string
]:unknown
;className?
: Classname | undefined;comparator?
:string
| (f
: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (string | FlexibleOpt...,operator
:string
) =>boolean
;defaultOperator?
:string
;defaultValue?
:any
;disabled?
:boolean
;id?
:string
;inputType?
: InputType | null | undefined;label
:string
;matchModes?
:boolean
|MatchMode
[] |FlexibleOption
<MatchMode
>[];name
:string
;operators?
: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<string>[] | (string | FlexibleOption<...>)[] | undefined;placeholder?
:string
;subproperties?
: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (s...;validator?
:RuleValidator
;value
:string
;valueEditorType?
: ValueEditorType | ((operator: string) => ValueEditorType) | undefined;values?
: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | undefined;valueSources?
: ValueSources | ValueSourceFlexibleOptions | ((operator: string) => ValueSources | ValueSourceFlexibleOptions) | undefined; }>;validator?
:RuleValidator
;value
:string
;valueEditorType?
:ValueEditorType
| (operator
:string
) =>ValueEditorType
;values?
:FlexibleOptionList
<{[key
:string
]:unknown
;disabled?
:boolean
;label
:string
;name
:string
;value
:string
; }>;valueSources?
:ValueSources
|ValueSourceFlexibleOptions
| (operator
:string
) => ValueSources | ValueSourceFlexibleOptions; }>,operator
:string
): {[key
:string
]:unknown
;className?
:Classname
;comparator?
:string
| (f
: {[key
:string
]:unknown
;className?
:Classname
;comparator?
: string | ((f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (string...;defaultOperator?
:string
;defaultValue?
:any
;disabled?
:boolean
;id?
:string
;inputType?
:null
|InputType
;label
:string
;matchModes?
:boolean
|MatchMode
[] |FlexibleOption
<MatchMode
>[];name
:string
;operators?
:string
[] |FlexibleOptionList
<{[key
:string
]:unknown
;disabled?
:boolean
;label
:string
;name
:string
;value
:string
; }> |FlexibleOption
<string
>[] | string | FlexibleOption<string>[];placeholder?
:string
;subproperties?
:FlexibleOptionList
<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (string | FlexibleOpt...>;validator?
:RuleValidator
;value
:string
;valueEditorType?
:ValueEditorType
| (operator
:string
) =>ValueEditorType
;values?
:FlexibleOptionList
<{[key
:string
]:unknown
;disabled?
:boolean
;label
:string
;name
:string
;value
:string
; }>;valueSources?
:ValueSources
|ValueSourceFlexibleOptions
| (operator
:string
) => ValueSources | ValueSourceFlexibleOptions; },operator
:string
) =>boolean
;defaultOperator?
:string
;defaultValue?
:any
;disabled?
:boolean
;id?
:string
;inputType?
:null
|InputType
;label
:string
;matchModes?
:boolean
|MatchMode
[] |FlexibleOption
<MatchMode
>[];name
:string
;operators?
:string
[] |FlexibleOption
<string
>[] | string | FlexibleOption<string>[] |FlexibleOptionList
<{[key
:string
]:unknown
;disabled?
:boolean
;label
:string
;name
:string
;value
:string
; }>;placeholder?
:string
;subproperties?
:FlexibleOptionList
<{[key
:string
]:unknown
;className?
: Classname | undefined;comparator?
:string
| (f
: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (string | FlexibleOpt...,operator
:string
) =>boolean
;defaultOperator?
:string
;defaultValue?
:any
;disabled?
:boolean
;id?
:string
;inputType?
: InputType | null | undefined;label
:string
;matchModes?
:boolean
|MatchMode
[] |FlexibleOption
<MatchMode
>[];name
:string
;operators?
: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<string>[] | (string | FlexibleOption<...>)[] | undefined;placeholder?
:string
;subproperties?
: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (s...;validator?
:RuleValidator
;value
:string
;valueEditorType?
: ValueEditorType | ((operator: string) => ValueEditorType) | undefined;values?
: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | undefined;valueSources?
: ValueSources | ValueSourceFlexibleOptions | ((operator: string) => ValueSources | ValueSourceFlexibleOptions) | undefined; }>;validator?
:RuleValidator
;value
:string
;valueEditorType?
:ValueEditorType
| (operator
:string
) =>ValueEditorType
;values?
:FlexibleOptionList
<{[key
:string
]:unknown
;disabled?
:boolean
;label
:string
;name
:string
;value
:string
; }>;valueSources?
:ValueSources
|ValueSourceFlexibleOptions
| (operator
:string
) => ValueSources | ValueSourceFlexibleOptions; }[] | {label
:string
;options
:WithUnknownIndex
<{[key
:string
]:unknown
;className?
:Classname
;comparator?
:string
| (f
: {[key
:string
]:unknown
;className?
:Classname
;comparator?
: string | ((f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (string...;defaultOperator?
:string
;defaultValue?
:any
;disabled?
:boolean
;id?
:string
;inputType?
:null
|InputType
;label
:string
;matchModes?
:boolean
| ...[] | ...[];name
:string
;operators?
: ...[] |FlexibleOptionList
<...> | ...[] | ...[];placeholder?
:string
;subproperties?
:FlexibleOptionList
<...>;validator?
:RuleValidator
;value
:string
;valueEditorType?
:ValueEditorType
| (operator
: ...) => ...;values?
:FlexibleOptionList
<...>;valueSources?
:ValueSources
|ValueSourceFlexibleOptions
| (operator
: ...) => ...; },operator
:string
) =>boolean
;defaultOperator?
:string
;defaultValue?
:any
;disabled?
:boolean
;id?
:string
;inputType?
:null
|InputType
;label
:string
;matchModes?
:boolean
|MatchMode
[] |FlexibleOption
<MatchMode
>[];name
:string
;operators?
:string
[] |FlexibleOption
<string
>[] | string | FlexibleOption<string>[] |FlexibleOptionList
<{[key
:string
]:unknown
;disabled?
:boolean
;label
:string
;name
:string
;value
:string
; }>;placeholder?
:string
;subproperties?
:FlexibleOptionList
<{[key
:string
]:unknown
;className?
: Classname | undefined;comparator?
:string
| (f
: ...,operator
: ...) => ...;defaultOperator?
:string
;defaultValue?
:any
;disabled?
:boolean
;id?
:string
;inputType?
: InputType | null | undefined;label
:string
;matchModes?
:boolean
| ...[] | ...[];name
:string
;operators?
: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<string>[] | (string | FlexibleOption<...>)[] | undefined;placeholder?
:string
;subproperties?
: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (s...;validator?
:RuleValidator
;value
:string
;valueEditorType?
: ValueEditorType | ((operator: string) => ValueEditorType) | undefined;values?
: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | undefined;valueSources?
: ValueSources | ValueSourceFlexibleOptions | ((operator: string) => ValueSources | ValueSourceFlexibleOptions) | undefined; }>;validator?
:RuleValidator
;value
:string
;valueEditorType?
:ValueEditorType
| (operator
:string
) =>ValueEditorType
;values?
:FlexibleOptionList
<{[key
:string
]:unknown
;disabled?
:boolean
;label
:string
;name
:string
;value
:string
; }>;valueSources?
:ValueSources
|ValueSourceFlexibleOptions
| (operator
:string
) => ValueSources | ValueSourceFlexibleOptions; }>[]; }[]
Defined in: packages/react-querybuilder/src/utils/filterFieldsByComparator.ts:27
For a given FullField, returns the fields
list filtered for
other fields that match by comparator
. Only fields other than the
one in question will ever be included, even if comparator
is null
or undefined
. If comparator
is a string, fields with the same value
for that property will be included. If comparator
is a function, each
field will be passed to the function along with the operator
and fields
for which the function returns true
will be included.
Parameters
Parameter | Type | Description |
---|---|---|
field | {[key : string ]: unknown ; className? : Classname ; comparator? : string | (f : {[key : string ]: unknown ; className? : Classname ; comparator? : string | ((f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (string...; defaultOperator? : string ; defaultValue? : any ; disabled? : boolean ; id? : string ; inputType? : null | InputType ; label : string ; matchModes? : boolean | MatchMode [] | FlexibleOption <MatchMode >[]; name : string ; operators? : string [] | FlexibleOptionList <{[key : string ]: unknown ; disabled? : boolean ; label : string ; name : string ; value : string ; }> | FlexibleOption <string >[] | string | FlexibleOption<string>[]; placeholder? : string ; subproperties? : FlexibleOptionList <{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (string | FlexibleOpt...>; validator? : RuleValidator ; value : string ; valueEditorType? : ValueEditorType | (operator : string ) => ValueEditorType ; values? : FlexibleOptionList <{[key : string ]: unknown ; disabled? : boolean ; label : string ; name : string ; value : string ; }>; valueSources? : ValueSources | ValueSourceFlexibleOptions | (operator : string ) => ValueSources | ValueSourceFlexibleOptions; }, operator : string ) => boolean ; defaultOperator? : string ; defaultValue? : any ; disabled? : boolean ; id? : string ; inputType? : null | InputType ; label : string ; matchModes? : boolean | MatchMode [] | FlexibleOption <MatchMode >[]; name : string ; operators? : string [] | FlexibleOptionList <{[key : string ]: unknown ; disabled? : boolean ; label : string ; name : string ; value : string ; }> | FlexibleOption <string >[] | string | FlexibleOption<string>[]; placeholder? : string ; subproperties? : FlexibleOptionList <{[key : string ]: unknown ; className? : Classname | undefined; comparator? : string | (f : { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (string | FlexibleOpt..., operator : string ) => boolean ; defaultOperator? : string ; defaultValue? : any ; disabled? : boolean ; id? : string ; inputType? : InputType | null | undefined; label : string ; matchModes? : boolean | MatchMode [] | FlexibleOption <MatchMode >[]; name : string ; operators? : string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<string>[] | (string | FlexibleOption<...>)[] | undefined; placeholder? : string ; subproperties? : FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (s...; validator? : RuleValidator ; value : string ; valueEditorType? : ValueEditorType | ((operator: string) => ValueEditorType) | undefined; values? : FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | undefined; valueSources? : ValueSources | ValueSourceFlexibleOptions | ((operator: string) => ValueSources | ValueSourceFlexibleOptions) | undefined; }>; validator? : RuleValidator ; value : string ; valueEditorType? : ValueEditorType | (operator : string ) => ValueEditorType ; values? : FlexibleOptionList <{[key : string ]: unknown ; disabled? : boolean ; label : string ; name : string ; value : string ; }>; valueSources? : ValueSources | ValueSourceFlexibleOptions | (operator : string ) => ValueSources | ValueSourceFlexibleOptions; } | The field in question. |
field.className? | Classname | - |
field.comparator? | string | (f : {[key : string ]: unknown ; className? : Classname ; comparator? : string | ((f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (string...; defaultOperator? : string ; defaultValue? : any ; disabled? : boolean ; id? : string ; inputType? : null | InputType ; label : string ; matchModes? : boolean | MatchMode [] | FlexibleOption <MatchMode >[]; name : string ; operators? : string [] | FlexibleOptionList <{[key : string ]: unknown ; disabled? : boolean ; label : string ; name : string ; value : string ; }> | FlexibleOption <string >[] | string | FlexibleOption<string>[]; placeholder? : string ; subproperties? : FlexibleOptionList <{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (string | FlexibleOpt...>; validator? : RuleValidator ; value : string ; valueEditorType? : ValueEditorType | (operator : string ) => ValueEditorType ; values? : FlexibleOptionList <{[key : string ]: unknown ; disabled? : boolean ; label : string ; name : string ; value : string ; }>; valueSources? : ValueSources | ValueSourceFlexibleOptions | (operator : string ) => ValueSources | ValueSourceFlexibleOptions; }, operator : string ) => boolean | - |
field.defaultOperator? | string | - |
field.defaultValue? | any | - |
field.disabled? | boolean | - |
field.id? | string | - |
field.inputType? | null | InputType | - |
field.label | string | - |
field.matchModes? | boolean | MatchMode [] | FlexibleOption <MatchMode >[] | - |
field.name | string | - |
field.operators? | string [] | FlexibleOptionList <{[key : string ]: unknown ; disabled? : boolean ; label : string ; name : string ; value : string ; }> | FlexibleOption <string >[] | string | FlexibleOption<string>[] | - |
field.placeholder? | string | - |
field.subproperties? | FlexibleOptionList <{[key : string ]: unknown ; className? : Classname | undefined; comparator? : string | (f : { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (string | FlexibleOpt..., operator : string ) => boolean ; defaultOperator? : string ; defaultValue? : any ; disabled? : boolean ; id? : string ; inputType? : InputType | null | undefined; label : string ; matchModes? : boolean | MatchMode [] | FlexibleOption <MatchMode >[]; name : string ; operators? : string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<string>[] | (string | FlexibleOption<...>)[] | undefined; placeholder? : string ; subproperties? : FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (s...; validator? : RuleValidator ; value : string ; valueEditorType? : ValueEditorType | ((operator: string) => ValueEditorType) | undefined; values? : FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | undefined; valueSources? : ValueSources | ValueSourceFlexibleOptions | ((operator: string) => ValueSources | ValueSourceFlexibleOptions) | undefined; }> | Properties of items in the value. |
field.validator? | RuleValidator | - |
field.value | string | - |
field.valueEditorType? | ValueEditorType | (operator : string ) => ValueEditorType | - |
field.values? | FlexibleOptionList <{[key : string ]: unknown ; disabled? : boolean ; label : string ; name : string ; value : string ; }> | - |
field.valueSources? | ValueSources | ValueSourceFlexibleOptions | (operator : string ) => ValueSources | ValueSourceFlexibleOptions | - |
fields | OptionList <{[key : string ]: unknown ; className? : Classname ; comparator? : string | (f : {[key : string ]: unknown ; className? : Classname ; comparator? : string | ((f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (string...; defaultOperator? : string ; defaultValue? : any ; disabled? : boolean ; id? : string ; inputType? : null | InputType ; label : string ; matchModes? : boolean | MatchMode [] | FlexibleOption <MatchMode >[]; name : string ; operators? : string [] | FlexibleOptionList <{[key : string ]: unknown ; disabled? : boolean ; label : string ; name : string ; value : string ; }> | FlexibleOption <string >[] | string | FlexibleOption<string>[]; placeholder? : string ; subproperties? : FlexibleOptionList <{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (string | FlexibleOpt...>; validator? : RuleValidator ; value : string ; valueEditorType? : ValueEditorType | (operator : string ) => ValueEditorType ; values? : FlexibleOptionList <{[key : string ]: unknown ; disabled? : boolean ; label : string ; name : string ; value : string ; }>; valueSources? : ValueSources | ValueSourceFlexibleOptions | (operator : string ) => ValueSources | ValueSourceFlexibleOptions; }, operator : string ) => boolean ; defaultOperator? : string ; defaultValue? : any ; disabled? : boolean ; id? : string ; inputType? : null | InputType ; label : string ; matchModes? : boolean | MatchMode [] | FlexibleOption <MatchMode >[]; name : string ; operators? : string [] | FlexibleOptionList <{[key : string ]: unknown ; disabled? : boolean ; label : string ; name : string ; value : string ; }> | FlexibleOption <string >[] | string | FlexibleOption<string>[]; placeholder? : string ; subproperties? : FlexibleOptionList <{[key : string ]: unknown ; className? : Classname | undefined; comparator? : string | (f : { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (string | FlexibleOpt..., operator : string ) => boolean ; defaultOperator? : string ; defaultValue? : any ; disabled? : boolean ; id? : string ; inputType? : InputType | null | undefined; label : string ; matchModes? : boolean | MatchMode [] | FlexibleOption <MatchMode >[]; name : string ; operators? : string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<string>[] | (string | FlexibleOption<...>)[] | undefined; placeholder? : string ; subproperties? : FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (s...; validator? : RuleValidator ; value : string ; valueEditorType? : ValueEditorType | ((operator: string) => ValueEditorType) | undefined; values? : FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | undefined; valueSources? : ValueSources | ValueSourceFlexibleOptions | ((operator: string) => ValueSources | ValueSourceFlexibleOptions) | undefined; }>; validator? : RuleValidator ; value : string ; valueEditorType? : ValueEditorType | (operator : string ) => ValueEditorType ; values? : FlexibleOptionList <{[key : string ]: unknown ; disabled? : boolean ; label : string ; name : string ; value : string ; }>; valueSources? : ValueSources | ValueSourceFlexibleOptions | (operator : string ) => ValueSources | ValueSourceFlexibleOptions; }> | The full FullField list to be filtered. |
operator | string | - |
Returns
{[key
: string
]: unknown
; className?
: Classname
; comparator?
: string
| (f
: {[key
: string
]: unknown
; className?
: Classname
; comparator?
: string | ((f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (string...; defaultOperator?
: string
; defaultValue?
: any
; disabled?
: boolean
; id?
: string
; inputType?
: null
| InputType
; label
: string
; matchModes?
: boolean
| MatchMode
[] | FlexibleOption
<MatchMode
>[]; name
: string
; operators?
: string
[] | FlexibleOptionList
<{[key
: string
]: unknown
; disabled?
: boolean
; label
: string
; name
: string
; value
: string
; }> | FlexibleOption
<string
>[] | string | FlexibleOption<string>[]; placeholder?
: string
; subproperties?
: FlexibleOptionList
<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (string | FlexibleOpt...>; validator?
: RuleValidator
; value
: string
; valueEditorType?
: ValueEditorType
| (operator
: string
) => ValueEditorType
; values?
: FlexibleOptionList
<{[key
: string
]: unknown
; disabled?
: boolean
; label
: string
; name
: string
; value
: string
; }>; valueSources?
: ValueSources
| ValueSourceFlexibleOptions
| (operator
: string
) => ValueSources | ValueSourceFlexibleOptions; }, operator
: string
) => boolean
; defaultOperator?
: string
; defaultValue?
: any
; disabled?
: boolean
; id?
: string
; inputType?
: null
| InputType
; label
: string
; matchModes?
: boolean
| MatchMode
[] | FlexibleOption
<MatchMode
>[]; name
: string
; operators?
: string
[] | FlexibleOption
<string
>[] | string | FlexibleOption<string>[] | FlexibleOptionList
<{[key
: string
]: unknown
; disabled?
: boolean
; label
: string
; name
: string
; value
: string
; }>; placeholder?
: string
; subproperties?
: FlexibleOptionList
<{[key
: string
]: unknown
; className?
: Classname | undefined; comparator?
: string
| (f
: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (string | FlexibleOpt..., operator
: string
) => boolean
; defaultOperator?
: string
; defaultValue?
: any
; disabled?
: boolean
; id?
: string
; inputType?
: InputType | null | undefined; label
: string
; matchModes?
: boolean
| MatchMode
[] | FlexibleOption
<MatchMode
>[]; name
: string
; operators?
: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<string>[] | (string | FlexibleOption<...>)[] | undefined; placeholder?
: string
; subproperties?
: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (s...; validator?
: RuleValidator
; value
: string
; valueEditorType?
: ValueEditorType | ((operator: string) => ValueEditorType) | undefined; values?
: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | undefined; valueSources?
: ValueSources | ValueSourceFlexibleOptions | ((operator: string) => ValueSources | ValueSourceFlexibleOptions) | undefined; }>; validator?
: RuleValidator
; value
: string
; valueEditorType?
: ValueEditorType
| (operator
: string
) => ValueEditorType
; values?
: FlexibleOptionList
<{[key
: string
]: unknown
; disabled?
: boolean
; label
: string
; name
: string
; value
: string
; }>; valueSources?
: ValueSources
| ValueSourceFlexibleOptions
| (operator
: string
) => ValueSources | ValueSourceFlexibleOptions; }[]
{ label
: string
; options
: WithUnknownIndex
<{[key
: string
]: unknown
; className?
: Classname
; comparator?
: string
| (f
: {[key
: string
]: unknown
; className?
: Classname
; comparator?
: string | ((f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (string...; defaultOperator?
: string
; defaultValue?
: any
; disabled?
: boolean
; id?
: string
; inputType?
: null
| InputType
; label
: string
; matchModes?
: boolean
| ...[] | ...[]; name
: string
; operators?
: ...[] | FlexibleOptionList
<...> | ...[] | ...[]; placeholder?
: string
; subproperties?
: FlexibleOptionList
<...>; validator?
: RuleValidator
; value
: string
; valueEditorType?
: ValueEditorType
| (operator
: ...) => ...; values?
: FlexibleOptionList
<...>; valueSources?
: ValueSources
| ValueSourceFlexibleOptions
| (operator
: ...) => ...; }, operator
: string
) => boolean
; defaultOperator?
: string
; defaultValue?
: any
; disabled?
: boolean
; id?
: string
; inputType?
: null
| InputType
; label
: string
; matchModes?
: boolean
| MatchMode
[] | FlexibleOption
<MatchMode
>[]; name
: string
; operators?
: string
[] | FlexibleOption
<string
>[] | string | FlexibleOption<string>[] | FlexibleOptionList
<{[key
: string
]: unknown
; disabled?
: boolean
; label
: string
; name
: string
; value
: string
; }>; placeholder?
: string
; subproperties?
: FlexibleOptionList
<{[key
: string
]: unknown
; className?
: Classname | undefined; comparator?
: string
| (f
: ..., operator
: ...) => ...; defaultOperator?
: string
; defaultValue?
: any
; disabled?
: boolean
; id?
: string
; inputType?
: InputType | null | undefined; label
: string
; matchModes?
: boolean
| ...[] | ...[]; name
: string
; operators?
: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<string>[] | (string | FlexibleOption<...>)[] | undefined; placeholder?
: string
; subproperties?
: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (s...; validator?
: RuleValidator
; value
: string
; valueEditorType?
: ValueEditorType | ((operator: string) => ValueEditorType) | undefined; values?
: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | undefined; valueSources?
: ValueSources | ValueSourceFlexibleOptions | ((operator: string) => ValueSources | ValueSourceFlexibleOptions) | undefined; }>; validator?
: RuleValidator
; value
: string
; valueEditorType?
: ValueEditorType
| (operator
: string
) => ValueEditorType
; values?
: FlexibleOptionList
<{[key
: string
]: unknown
; disabled?
: boolean
; label
: string
; name
: string
; value
: string
; }>; valueSources?
: ValueSources
| ValueSourceFlexibleOptions
| (operator
: string
) => ValueSources | ValueSourceFlexibleOptions; }>[]; }[]
API documentation is generated from the latest commit on the main
branch. It may be somewhat inconsistent with official releases of React Query Builder.