Skip to main content

CommonSubComponentProps<F extends FullOption = FullField, O extends string = string>

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

Base interface for all subcomponents.

Extended by​

Type Parameters​

Type ParameterDefault type
F extends FullOptionFullField
O extends stringstring

Properties​

className?​

optional className?: string

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

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.

context?​

optional context?: any

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

Container for custom props that are passed to all components.

disabled?​

optional disabled?: boolean

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

Disables the control.

level​

level: number

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

The level of the current group. Always equal to path.length.

path​

path: Path

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

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

schema​

schema: Schema<F, O>

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

All subcomponents receive the configuration schema as a prop.

testID?​

optional testID?: string

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

Test ID for this component.

title?​

optional title?: string

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

The title/tooltip for this control.

validation?​

optional validation?: boolean | ValidationResult

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

Validation result of the parent rule/group.

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.