ValueEditorProps<F, O>

Props passed to valueEditor components.

Extends

• SelectorOrEditorProps<F, O>.CommonRuleSubComponentProps

Type parameters

Type parameter	Value
F extends FullField	FullField
O extends string	string

Properties

className?

optional className: string

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

Source

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

---

context?

optional context: any

Container for custom props that are passed to all components.

Inherited from

SelectorOrEditorProps . context

Source

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

---

disabled?

optional disabled: boolean

Disables the control.

Inherited from

SelectorOrEditorProps . disabled

Source

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

---

field

field: GetOptionIdentifierType<F>

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:164

---

fieldData

fieldData: F

The entire FullField object.

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:170

---

inputType?

optional inputType: null | InputType

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:172

---

level

level: number

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

Inherited from

SelectorOrEditorProps . level

Source

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

---

listsAsArrays?

optional listsAsArrays: boolean

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:175

---

operator

operator: O

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:165

---

parseNumbers?

optional parseNumbers: ParseNumbersMethod

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:176

---

path

path: Path

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

Inherited from

SelectorOrEditorProps . path

Source

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

---

rule

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

Inherited from

CommonRuleSubComponentProps . rule

Source

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

---

schema

schema: Schema<F, O>

All subcomponents receive the configuration schema as a prop.

Overrides

SelectorOrEditorProps . schema

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:184

---

selectorComponent?

optional selectorComponent: ComponentType <ValueSelectorProps <FullOption<string>>>

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:178

---

separator?

optional separator: ReactNode

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:177

---

skipHook?

optional skipHook: boolean

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

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:183

---

testID?

optional testID: string

Test ID for this component.

Inherited from

SelectorOrEditorProps . testID

Source

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

---

title?

optional title: string

The title/tooltip for this control.

Inherited from

SelectorOrEditorProps . title

Source

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

---

type?

optional type: ValueEditorType

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:171

---

validation?

optional validation: boolean | ValidationResult

Validation result of the parent rule/group.

Inherited from

SelectorOrEditorProps . validation

Source

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

---

value?

optional value: any

Overrides

SelectorOrEditorProps . value

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:167

---

valueSource

valueSource: ValueSource

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:168

---

values?

optional values: any[]

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:174

Methods

handleOnChange()

handleOnChange(value): void

Parameters

Parameter	Type
value	any

Returns

void

Inherited from

SelectorOrEditorProps . handleOnChange

Source

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

---

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.