Skip to main content

ValueEditorProps<F, O>

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

Props passed to valueEditor components.

Extends

Type Parameters

Type ParameterDefault type
F extends FullFieldFullField
O extends stringstring

Methods

handleOnChange()

handleOnChange(value: any): void

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

Parameters

ParameterType
valueany

Returns

void

Inherited from

SelectorOrEditorProps.handleOnChange

Properties

className?

optional className: string

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

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

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

Disables the control.

Inherited from

SelectorOrEditorProps.disabled


field

field: GetOptionIdentifierType<F>

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


fieldData

fieldData: F

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

The entire FullField object.


inputType?

optional inputType: null | InputType

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


level

level: number

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

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


operator

operator: O

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


parseNumbers?

optional parseNumbers: ParseNumbersPropConfig

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


path

path: Path

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

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

Inherited from

CommonRuleSubComponentProps.rule


schema

schema: Schema<F, O>

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

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


separator?

optional separator: ReactNode

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


skipHook?

optional skipHook: boolean

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

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

Test ID for this component.

Inherited from

SelectorOrEditorProps.testID


title?

optional title: string

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

The title/tooltip for this control.

Inherited from

SelectorOrEditorProps.title


type?

optional type: ValueEditorType

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


validation?

optional validation: boolean | ValidationResult

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

Validation result of the parent rule/group.

Inherited from

SelectorOrEditorProps.validation


value?

optional value: any

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

Overrides

SelectorOrEditorProps.value


values?

optional values: any[]

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


valueSource

valueSource: ValueSource

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


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.