getValueSourcesUtil()
getValueSourcesUtil<
F
,O
>(fieldData
:F
,operator
:string
,getValueSources?
: (field
:GetOptionIdentifierType
<F
>,operator
:O
,misc
: {fieldData
:F
; }) =>ValueSources
|ValueSourceFlexibleOptions
):ValueSourceFullOptions
Defined in: packages/react-querybuilder/src/utils/getValueSourcesUtil.ts:28
Utility function to get the value sources array for the given
field and operator. If the field definition does not define a
valueSources
property, the getValueSources
prop is used.
Returns [FullOption<"value">]
by default.
Type Parameters
Type Parameter |
---|
F extends {[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?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | undefined; ... 11 more ...; className?: Cl...; defaultOperator? : string ; defaultValue? : any ; disabled? : boolean ; id? : string ; inputType? : null | InputType ; label : string ; matchModes? : boolean | MatchMode [] | FlexibleOption <MatchMode >[]; name : string ; operators? : FlexibleOptionList <{[key : string ]: unknown ; disabled? : boolean ; label : string ; name : string ; value : string ; }>; placeholder? : string ; subproperties? : FlexibleOptionList <{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | undefined; ... 11 more ...; className?: Classname | unde...>; 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? : 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?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | undefined; ... 11 more ...; className?: Classname | unde..., 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? : FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | undefined; placeholder? : string ; subproperties? : FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | undefined; ... 11 more ...; className...; 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; } |
O extends string |
Parameters
Parameter | Type |
---|---|
fieldData | F |
operator | string |
getValueSources? | (field : GetOptionIdentifierType <F >, operator : O , misc : { fieldData : F ; }) => ValueSources | ValueSourceFlexibleOptions |
Returns
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.