ActionWithRulesAndAddersProps

Props passed to every action component that adds a rule or group.

Extends

• 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

ActionWithRulesProps.className

Defined in

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

---

context?

optional context: any

Container for custom props that are passed to all components.

Inherited from

ActionWithRulesProps.context

Defined in

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

---

disabled?

optional disabled: boolean

Disables the control.

Inherited from

ActionWithRulesProps.disabled

Defined in

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.

Inherited from

ActionWithRulesProps.disabledTranslation

Defined in

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

---

label?

optional label: ReactNode

Visible text.

Inherited from

ActionWithRulesProps.label

Defined in

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

---

level

level: number

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

Inherited from

ActionWithRulesProps.level

Defined in

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

---

path

path: Path

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

Inherited from

ActionWithRulesProps.path

Defined in

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.

Inherited from

ActionWithRulesProps.ruleOrGroup

Defined in

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

---

rules?

optional rules: RuleOrGroupArray

Rules already present for this group.

Inherited from

ActionWithRulesProps.rules

Defined in

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

---

schema

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

All subcomponents receive the configuration schema as a prop.

Inherited from

ActionWithRulesProps.schema

Defined in

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

---

testID?

optional testID: string

Test ID for this component.

Inherited from

ActionWithRulesProps.testID

Defined in

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

---

title?

optional title: string

The title/tooltip for this control.

Inherited from

ActionWithRulesProps.title

Defined in

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

---

validation?

optional validation: boolean | ValidationResult

Validation result of the parent rule/group.

Inherited from

ActionWithRulesProps.validation

Defined in

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

Methods

handleOnClick()

handleOnClick(e, context?): void

Triggers the addition of a new rule or group. The second parameter will be forwarded to the onAddRule or onAddGroup callback, appropriately.

Parameters

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

Returns

void

Overrides

ActionWithRulesProps.handleOnClick

Defined in

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

---

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.