ActionElementREProps

Defined in: packages/rules-engine/src/components/ActionElementRE.ts:5

Extends

• Omit<ActionProps, "schema" | "ruleOrGroup" | "rules">

Methods

handleOnClick()

handleOnClick(e?: MouseEvent<Element, MouseEvent>, context?: any): void

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

Triggers the action, e.g. the addition of a new rule or group. The second parameter will be forwarded to the onAddRule or onAddGroup callback if appropriate.

Parameters

Parameter	Type
e?	MouseEvent<Element, MouseEvent>
context?	any

Returns

void

Inherited from

Omit.handleOnClick

Properties

className?

optional className: string

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

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

Omit.className

---

context?

optional context: any

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

Container for custom props that are passed to all components.

Inherited from

Omit.context

---

disabled?

optional disabled: boolean

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

Disables the control.

Inherited from

Omit.disabled

---

disabledTranslation?

optional disabledTranslation: TranslationWithLabel

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

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

Inherited from

Omit.disabledTranslation

---

label?

optional label: ReactNode

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

Visible text.

Inherited from

Omit.label

---

level

level: number

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

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

Inherited from

Omit.level

---

path

path: Path

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

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

Inherited from

Omit.path

---

schema

schema: SchemaRE

Defined in: packages/rules-engine/src/components/ActionElementRE.ts:9

---

testID?

optional testID: string

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

Test ID for this component.

Inherited from

Omit.testID

---

title?

optional title: string

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

The title/tooltip for this control.

Inherited from

Omit.title

---

validation?

optional validation: boolean | ValidationResult

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

Validation result of the parent rule/group.

Inherited from

Omit.validation

---

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.