ActionProps

Props passed to every action component (rendered as <button> by default).

Extends

• CommonSubComponentProps

Extended by

• ActionWithRulesProps

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

CommonSubComponentProps . className

Source

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

---

context?

optional context: any

Container for custom props that are passed to all components.

Inherited from

CommonSubComponentProps . context

Source

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

---

disabled?

optional disabled: boolean

Disables the control.

Inherited from

CommonSubComponentProps . disabled

Source

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

---

disabledTranslation?

optional disabledTranslation: TranslationWithLabel

Translation which overrides the regular label/title props when the element is disabled.

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:67

---

label?

optional label: ReactNode

Visible text.

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:60

---

level

level: number

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

Inherited from

CommonSubComponentProps . level

Source

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

---

path

path: Path

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

Inherited from

CommonSubComponentProps . path

Source

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

---

ruleOrGroup

ruleOrGroup: RuleType<string, string, any, string> | RuleGroupTypeAny

The RuleType or RuleGroupType/RuleGroupTypeIC associated with this element.

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:72

---

schema

schema: Schema <FullField<string, string, string, Option<string>, Option<string>>, string>

All subcomponents receive the configuration schema as a prop.

Inherited from

CommonSubComponentProps . schema

Source

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

---

testID?

optional testID: string

Test ID for this component.

Inherited from

CommonSubComponentProps . testID

Source

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

---

title?

optional title: string

The title/tooltip for this control.

Inherited from

CommonSubComponentProps . title

Source

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

---

validation?

optional validation: boolean | ValidationResult

Validation result of the parent rule/group.

Inherited from

CommonSubComponentProps . validation

Source

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

Methods

handleOnClick()

handleOnClick(e?): void

Call this function to trigger the action.

Parameters

Parameter	Type
e?	MouseEvent<Element, MouseEvent>

Returns

void

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:62

---

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.