ValueEditorProps<F, O>
Props passed to valueEditor
components.
Extends
Type Parameters
Type Parameter | Default type |
---|---|
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
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:166
fieldData
fieldData:
F
The entire FullField object.
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:172
inputType?
optional
inputType:null
|InputType
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:174
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:177
operator
operator:
O
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:167
parseNumbers?
optional
parseNumbers:ParseNumbersPropConfig
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:178
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:186
selectorComponent?
optional
selectorComponent:ComponentType
<ValueSelectorProps
<FullOption
<string
>>>
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:180
separator?
optional
separator:ReactNode
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:179
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:185
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:173
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:169
values?
optional
values:any
[]
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:176
valueSource
valueSource:
ValueSource
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:170
Methods
handleOnChange()
handleOnChange(
value
):void
Parameters
Parameter | Type |
---|---|
value | any |
Returns
void
Inherited from
SelectorOrEditorProps
.handleOnChange
Defined in
packages/react-querybuilder/src/types/props.ts:72
API documentation is generated from the latest commit on the main
branch. It may be somewhat inconsistent with official releases of React Query Builder.