CommonSubComponentProps<F, O>

Base interface for all subcomponents.

Extended by

• SelectorOrEditorProps
• ActionProps
• NotToggleProps
• ShiftActionsProps
• DragHandleProps

Type Parameters

Type Parameter	Default type
F extends FullOption	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.

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.

Defined in

packages/react-querybuilder/src/types/props.ts:54

---

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.