Interface: ValueEditorProps<F, O>
react-querybuilder.ValueEditorProps
Props passed to valueEditor components.
Type parameters
| Name | Type |
|---|---|
F | extends FullField = FullField |
O | extends string = string |
Hierarchy
-
SelectorOrEditorProps<F,O> -
↳
ValueEditorProps
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
Defined in
packages/react-querybuilder/src/types/props.ts:29
context
Optional context: any
Container for custom props that are passed to all components.
Inherited from
Defined in
packages/react-querybuilder/src/types/props.ts:50
disabled
Optional disabled: boolean
Disables the control.
Inherited from
SelectorOrEditorProps.disabled
Defined in
packages/react-querybuilder/src/types/props.ts:45
field
field: GetOptionIdentifierType<F>
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:164
fieldData
fieldData: F
The entire FullField object.
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:170
inputType
Optional inputType: null | InputType
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:172
level
level: number
The level of the current group. Always equal to path.length.
Inherited from
Defined in
packages/react-querybuilder/src/types/props.ts:37
listsAsArrays
Optional listsAsArrays: boolean
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:175
operator
operator: O
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:165
parseNumbers
Optional parseNumbers: ParseNumbersMethod
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:176
path
path: Path
Path to this subcomponent's rule/group within the query.
Inherited from
Defined in
packages/react-querybuilder/src/types/props.ts:33
rule
rule: RuleType<string, string, any, string>
Inherited from
CommonRuleSubComponentProps.rule
Defined in
packages/react-querybuilder/src/types/props.ts:79
schema
schema: Schema<F, O>
All subcomponents receive the configuration schema as a prop.
Overrides
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:184
selectorComponent
Optional selectorComponent: ComponentType<ValueSelectorProps<FullOption<string>>>
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:178
separator
Optional separator: ReactNode
Defined in
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.
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:183
testID
Optional testID: string
Test ID for this component.
Inherited from
Defined in
packages/react-querybuilder/src/types/props.ts:58
title
Optional title: string
The title/tooltip for this control.
Inherited from
Defined in
packages/react-querybuilder/src/types/props.ts:41
type
Optional type: ValueEditorType
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:171
validation
Optional validation: boolean | ValidationResult
Validation result of the parent rule/group.
Inherited from
SelectorOrEditorProps.validation
Defined in
packages/react-querybuilder/src/types/props.ts:54
value
Optional value: any
Overrides
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:167
valueSource
valueSource: ValueSource
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:168
values
Optional values: any[]
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:174
Methods
handleOnChange
handleOnChange(value): void
Parameters
| Name | Type |
|---|---|
value | any |
Returns
void
Inherited from
SelectorOrEditorProps.handleOnChange