Interface: CommonSubComponentProps<F, O>
react-querybuilder.CommonSubComponentProps
Base interface for all subcomponents.
Type parameters
Name | Type |
---|---|
F | extends FullOption = FullField |
O | extends string = string |
Hierarchy
-
CommonSubComponentProps
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.
Defined in
packages/react-querybuilder/src/types/props.ts:29
context
Optional
context: any
Container for custom props that are passed to all components.
Defined in
packages/react-querybuilder/src/types/props.ts:50
disabled
Optional
disabled: boolean
Disables the control.
Defined in
packages/react-querybuilder/src/types/props.ts:45
level
level: number
The level of the current group. Always equal to path.length
.
Defined in
packages/react-querybuilder/src/types/props.ts:37
path
path: Path
Path to this subcomponent's rule/group within the query.
Defined in
packages/react-querybuilder/src/types/props.ts:33
schema
schema: Schema
<F
, O
>
All subcomponents receive the configuration schema as a prop.
Defined in
packages/react-querybuilder/src/types/props.ts:62
testID
Optional
testID: string
Test ID for this component.
Defined in
packages/react-querybuilder/src/types/props.ts:58
title
Optional
title: string
The title/tooltip for this control.
Defined in
packages/react-querybuilder/src/types/props.ts:41
validation
Optional
validation: boolean
| ValidationResult
Validation result of the parent rule/group.