Skip to main content

ValueEditorProps<F, O>

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

Props passed to valueEditor components.

Extends

Extended by

Type Parameters

Type ParameterDefault type
F extends FullFieldFullField
O extends stringstring

Methods

handleOnChange()

handleOnChange(value: any): void

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

Parameters

ParameterType
valueany

Returns

void

Inherited from

SelectorOrEditorProps.handleOnChange

Properties

className?

optional className: string

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

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

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

Disables the control.

Inherited from

SelectorOrEditorProps.disabled


field

field: GetOptionIdentifierType<F>

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


fieldData

fieldData: F

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

The entire FullField object.


inputType?

optional inputType: null | InputType

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


level

level: number

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

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


operator

operator: O

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


parseNumbers?

optional parseNumbers: ParseNumbersPropConfig

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


path

path: Path

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

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

Inherited from

SelectorOrEditorProps.path


rule

rule: RuleType

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

Inherited from

CommonRuleSubComponentProps.rule


schema

schema: Schema<F, O>

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

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


separator?

optional separator: ReactNode

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


skipHook?

optional skipHook: boolean

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

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

Test ID for this component.

Inherited from

SelectorOrEditorProps.testID


title?

optional title: string

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

The title/tooltip for this control.

Inherited from

SelectorOrEditorProps.title


type?

optional type: ValueEditorType

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


validation?

optional validation: boolean | ValidationResult

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

Validation result of the parent rule/group.

Inherited from

SelectorOrEditorProps.validation


value?

optional value: any

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

Overrides

SelectorOrEditorProps.value


values?

optional values: any[]

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


valueSource

valueSource: ValueSource

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


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.