FluentValueSelectorProps

Defined in: packages/fluent/src/FluentValueSelector.tsx:11

Extends

• VersatileSelectorProps.SelectProps.DropdownProps

Indexable

[key: string]: any

[key: number]: any

[key: symbol]: any

Methods

handleOnChange()

handleOnChange(value: any): void

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:101

Parameters

Parameter	Type
value	any

Returns

void

Inherited from

VersatileSelectorProps.handleOnChange

Properties

appearance?

optional appearance: "outline" | "underline" | "filled-darker" | "filled-lighter"

Defined in: node_modules/@fluentui/react-select/dist/index.d.ts:38

Controls the colors and borders of the Select.

Default

'outline'

Inherited from

SelectProps.appearance

---

className?

optional className: string

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:56

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

VersatileSelectorProps.className

---

context?

optional context: any

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:77

Container for custom props that are passed to all components.

Inherited from

VersatileSelectorProps.context

---

disabled?

optional disabled: boolean

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

Disables the control.

Inherited from

VersatileSelectorProps.disabled

---

field?

optional field: string

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:153

Inherited from

VersatileSelectorProps.field

---

fieldData?

optional 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/propsUsingReact.ts:154

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

Inherited from

VersatileSelectorProps.fieldData

---

level

level: number

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:64

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

Inherited from

VersatileSelectorProps.level

---

listsAsArrays?

optional listsAsArrays: boolean

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:120

Inherited from

VersatileSelectorProps.listsAsArrays

---

multiple?

optional multiple: boolean

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:119

Inherited from

VersatileSelectorProps.multiple

---

onChange()?

optional onChange: (ev: ChangeEvent<HTMLSelectElement>, data: SelectOnChangeData) => void

Defined in: node_modules/@fluentui/react-select/dist/index.d.ts:42

Called when the user changes the select element's value by selecting an option.

Parameters

Parameter	Type
ev	ChangeEvent<HTMLSelectElement>
data	SelectOnChangeData

Returns

void

Inherited from

SelectProps.onChange

---

operator?

optional operator: string

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:141

Inherited from

VersatileSelectorProps.operator

---

options

options: (OptionGroup<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }>[] | { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }[]) & ({ ...; }[] | ... 1 more ... | undefined) & ((FullOperator<string>[] | OptionGroup<FullOperator<string>>[]) & (FullCombinator[] | OptionGroup<FullCombinator>[])) | undefined

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:109

Inherited from

VersatileSelectorProps.options

---

path

path: Path

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:60

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

Inherited from

VersatileSelectorProps.path

---

rule?

optional rule: RuleType<string, string, any, string>

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

Inherited from

VersatileSelectorProps.rule

---

rules?

optional rules: RuleOrGroupArray

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

Inherited from

VersatileSelectorProps.rules

---

schema

schema: Schema<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }, string> & Schema<{[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; }, string>

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:89

All subcomponents receive the configuration schema as a prop.

Inherited from

VersatileSelectorProps.schema

---

size?

optional size: "small" | "medium" | "large"

Defined in: node_modules/@fluentui/react-select/dist/index.d.ts:48

Matches the Input sizes

Default

'medium'

Inherited from

SelectProps.size

---

testID?

optional testID: string

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:85

Test ID for this component.

Inherited from

VersatileSelectorProps.testID

---

title?

optional title: string

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:68

The title/tooltip for this control.

Inherited from

VersatileSelectorProps.title

---

validation?

optional validation: boolean | ValidationResult

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:81

Validation result of the parent rule/group.

Inherited from

VersatileSelectorProps.validation

---

value?

optional value: string

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:99

Inherited from

VersatileSelectorProps.value

---

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.