CommonSubComponentProps<F, O>

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

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

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

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:50

Container for custom props that are passed to all components.

---

disabled?

optional disabled: boolean

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

Disables the control.

---

level

level: number

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

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

---

path

path: Path

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

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

---

schema

schema: Schema<F, O>

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

All subcomponents receive the configuration schema as a prop.

---

testID?

optional testID: string

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

Test ID for this component.

---

title?

optional title: string

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

The title/tooltip for this control.

---

validation?

optional validation: boolean | ValidationResult

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

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.