ValueSourceSelectorProps

Defined in: packages/react-querybuilder/src/types/props.ts:130

Props for valueSourceSelector components.

Extends

• BaseSelectorProps<FullOption>.CommonRuleSubComponentProps

Properties

className?

optional className: string

Defined in: packages/react-querybuilder/src/types/props.ts:29

CSS classNames to be applied.

This is string and not Classname because the Rule and RuleGroup components run clsx() to produce the className that gets passed to each subcomponent.

Inherited from

BaseSelectorProps.className

---

context?

optional context: any

Defined in: packages/react-querybuilder/src/types/props.ts:50

Container for custom props that are passed to all components.

Inherited from

BaseSelectorProps.context

---

disabled?

optional disabled: boolean

Defined in: packages/react-querybuilder/src/types/props.ts:45

Disables the control.

Inherited from

BaseSelectorProps.disabled

---

field

field: string

Defined in: packages/react-querybuilder/src/types/props.ts:134

---

fieldData

fieldData: { [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; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; ... 9 more ...; cl...; defaultOperator: string; defaultValue: any; disabled: boolean; id: string; inputType: null | InputType; label: string; name: string; operators: FlexibleOptionList<{ [key: string]: unknown; disabled: boolean; label: string; name: string; value: string; }>; placeholder: string; validator: RuleValidator; value: string; valueEditorType: ValueEditorType | (operator: string) => ValueEditorType; values: FlexibleOptionList<{ [key: string]: unknown; disabled: boolean; label: string; name: string; value: string; }>; valueSources: ValueSources | (operator: string) => ValueSources; }, operator: string) => boolean; defaultOperator: string; defaultValue: any; disabled: boolean; id: string; inputType: null | InputType; label: string; name: string; operators: FlexibleOptionList<{ [key: string]: unknown; disabled: boolean; label: string; name: string; value: string; }>; placeholder: string; validator: RuleValidator; value: string; valueEditorType: ValueEditorType | (operator: string) => ValueEditorType; values: FlexibleOptionList<{ [key: string]: unknown; disabled: boolean; label: string; name: string; value: string; }>; valueSources: ValueSources | (operator: string) => ValueSources; }

Defined in: packages/react-querybuilder/src/types/props.ts:135

Index Signature

[key: string]: unknown

className?

optional className: Classname

comparator?

optional 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; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; ... 9 more ...; cl...; defaultOperator: string; defaultValue: any; disabled: boolean; id: string; inputType: null | InputType; label: string; name: string; operators: FlexibleOptionList<{ [key: string]: unknown; disabled: boolean; label: string; name: string; value: string; }>; placeholder: string; validator: RuleValidator; value: string; valueEditorType: ValueEditorType | (operator: string) => ValueEditorType; values: FlexibleOptionList<{ [key: string]: unknown; disabled: boolean; label: string; name: string; value: string; }>; valueSources: ValueSources | (operator: string) => ValueSources; }, operator: string) => boolean

defaultOperator?

optional defaultOperator: string

defaultValue?

optional defaultValue: any

disabled?

optional disabled: boolean

id?

optional id: string

inputType?

optional inputType: null | InputType

label

label: string

name

name: string

operators?

optional operators: FlexibleOptionList<{ [key: string]: unknown; disabled: boolean; label: string; name: string; value: string; }>

placeholder?

optional placeholder: string

validator?

optional validator: RuleValidator

value

value: string

valueEditorType?

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

values?

optional values: FlexibleOptionList<{ [key: string]: unknown; disabled: boolean; label: string; name: string; value: string; }>

valueSources?

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

---

level

level: number

Defined in: packages/react-querybuilder/src/types/props.ts:37

The level of the current group. Always equal to path.length.

Inherited from

BaseSelectorProps.level

---

options

options: { [key: string]: unknown; disabled: boolean; label: string; name: ValueSource; value: ValueSource; }[] | OptionGroup<{ [key: string]: unknown; disabled: boolean; label: string; name: ValueSource; value: ValueSource; }>[]

Defined in: packages/react-querybuilder/src/types/props.ts:133

Overrides

BaseSelectorProps.options

---

path

path: Path

Defined in: packages/react-querybuilder/src/types/props.ts:33

Path to this subcomponent's rule/group within the query.

Inherited from

BaseSelectorProps.path

---

rule

rule: RuleType

Defined in: packages/react-querybuilder/src/types/props.ts:79

Inherited from

CommonRuleSubComponentProps.rule

---

schema

schema: Schema<{ [key: string]: unknown; disabled: boolean; label: string; name: string; value: string; }, string>

Defined in: packages/react-querybuilder/src/types/props.ts:62

All subcomponents receive the configuration schema as a prop.

Inherited from

BaseSelectorProps.schema

---

testID?

optional testID: string

Defined in: packages/react-querybuilder/src/types/props.ts:58

Test ID for this component.

Inherited from

BaseSelectorProps.testID

---

title?

optional title: string

Defined in: packages/react-querybuilder/src/types/props.ts:41

The title/tooltip for this control.

Inherited from

BaseSelectorProps.title

---

validation?

optional validation: boolean | ValidationResult

Defined in: packages/react-querybuilder/src/types/props.ts:54

Validation result of the parent rule/group.

Inherited from

BaseSelectorProps.validation

---

value?

optional value: string

Defined in: packages/react-querybuilder/src/types/props.ts:70

Inherited from

BaseSelectorProps.value

Methods

handleOnChange()

handleOnChange(value: any): void

Defined in: packages/react-querybuilder/src/types/props.ts:72

Parameters

Parameter	Type
value	any

Returns

void

Inherited from

BaseSelectorProps.handleOnChange

---

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.