ValueEditorProps<F, O>

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

Props passed to valueEditor components.

Extends

• SelectorOrEditorProps<F, O>.CommonRuleSubComponentProps

Extended by

• AntDValueEditorProps
• ChakraValueEditorProps
• FluentValueEditorProps
• MantineValueEditorProps
• MaterialValueEditorProps
• TremorValueEditorProps

Type Parameters

Type Parameter	Default type
F extends FullField	FullField
O extends string	string

Methods

handleOnChange()

handleOnChange(value: any): void

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

Parameters

Parameter	Type
value	any

Returns

void

Inherited from

SelectorOrEditorProps.handleOnChange

Properties

className?

optional className: string

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

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

SelectorOrEditorProps.className

---

context?

optional context: any

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

Container for custom props that are passed to all components.

Inherited from

SelectorOrEditorProps.context

---

disabled?

optional disabled: boolean

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

Disables the control.

Inherited from

SelectorOrEditorProps.disabled

---

field

field: GetOptionIdentifierType<F>

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

---

fieldData

fieldData: F

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

The entire FullField object.

---

inputType?

optional inputType: InputType | null

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

---

level

level: number

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

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

Inherited from

SelectorOrEditorProps.level

---

listsAsArrays?

optional listsAsArrays: boolean

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

---

operator

operator: O

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

---

parseNumbers?

optional parseNumbers: ParseNumbersPropConfig

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

---

path

path: Path

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

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

Inherited from

SelectorOrEditorProps.path

---

rule

rule: RuleType

Defined in: packages/core/src/types/queryBuilder.ts:12

Inherited from

CommonRuleSubComponentProps.rule

---

schema

schema: Schema<F, O>

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

All subcomponents receive the configuration schema as a prop.

Overrides

SelectorOrEditorProps.schema

---

selectorComponent?

optional selectorComponent: ComponentType<ValueSelectorProps<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>>

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

---

separator?

optional separator: ReactNode

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

---

skipHook?

optional skipHook: boolean

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

Only pass true if the useValueEditor hook has already run in a parent/ancestor component. See usage in the compatibility packages.

---

testID?

optional testID: string

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

Test ID for this component.

Inherited from

SelectorOrEditorProps.testID

---

title?

optional title: string

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

The title/tooltip for this control.

Inherited from

SelectorOrEditorProps.title

---

type?

optional type: ValueEditorType

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

---

validation?

optional validation: boolean | ValidationResult

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

Validation result of the parent rule/group.

Inherited from

SelectorOrEditorProps.validation

---

value?

optional value: any

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

Overrides

SelectorOrEditorProps.value

---

values?

optional values: any[]

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

---

valueSource

valueSource: ValueSource

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

---

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.