Skip to main content

ValueSelectorProps<OptType extends Option = FullOption>

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

Props for all value selector components.

Extends​

  • BaseSelectorProps<OptType>

Type Parameters​

Type ParameterDefault type
OptType extends OptionFullOption

Methods​

handleOnChange()​

handleOnChange(value: any): void

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

Parameters​

ParameterType
valueany

Returns​

void

Inherited from​

BaseSelectorProps.handleOnChange

Properties​

className?​

optional className?: string

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

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:97

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:92

Disables the control.

Inherited from​

BaseSelectorProps.disabled

level​

level: number

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

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

Inherited from​

BaseSelectorProps.level

listsAsArrays?​

optional listsAsArrays?: boolean

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

multiple?​

optional multiple?: boolean

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

options​

options: FullOptionList<OptType>

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

Inherited from​

BaseSelectorProps.options

path​

path: Path

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

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

Inherited from​

BaseSelectorProps.path

schema​

schema: Schema<ToFullOption<OptType>, string>

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

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:105

Test ID for this component.

Inherited from​

BaseSelectorProps.testID

title?​

optional title?: string

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

The title/tooltip for this control.

Inherited from​

BaseSelectorProps.title

validation?​

optional validation?: boolean | ValidationResult

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

Validation result of the parent rule/group.

Inherited from​

BaseSelectorProps.validation

value?​

optional value?: string

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

Inherited from​

BaseSelectorProps.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.