ActionWithRulesAndAddersProps

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

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

Extends

• ActionWithRulesProps

Methods

handleOnClick()

handleOnClick(e: MouseEvent, context?: any): void

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:105

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
context?	any

Returns

void

Overrides

ActionWithRulesProps.handleOnClick

Properties

className?

optional className: string

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

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

---

context?

optional context: any

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

Container for custom props that are passed to all components.

Inherited from

ActionWithRulesProps.context

---

disabled?

optional disabled: boolean

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

Disables the control.

Inherited from

ActionWithRulesProps.disabled

---

disabledTranslation?

optional disabledTranslation: TranslationWithLabel

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

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

Inherited from

ActionWithRulesProps.disabledTranslation

---

label?

optional label: ReactNode

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

Visible text.

Inherited from

ActionWithRulesProps.label

---

level

level: number

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

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

Inherited from

ActionWithRulesProps.level

---

path

path: Path

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

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

Inherited from

ActionWithRulesProps.path

---

ruleOrGroup

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

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:79

The RuleType or RuleGroupType/RuleGroupTypeIC associated with this element.

Inherited from

ActionWithRulesProps.ruleOrGroup

---

rules?

optional rules: RuleOrGroupArray

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:91

Rules already present for this group.

Inherited from

ActionWithRulesProps.rules

---

schema

schema: Schema<{[key: string]: unknown; className: Classname; comparator: string | (f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; ... 9 more ...; className?: Clas..., operator: string) => boolean; defaultOperator: string; defaultValue: any; disabled: boolean; id: string; inputType: null | InputType; label: string; name: string; operators: FlexibleOptionList<{[key: string]: unknown; disabled: boolean; label: string; name: string; value: string; }>; placeholder: string; validator: RuleValidator; value: string; valueEditorType: ValueEditorType | (operator: string) => ValueEditorType; values: FlexibleOptionList<{[key: string]: unknown; disabled: boolean; label: string; name: string; value: string; }>; valueSources: ValueSources | (operator: string) => ValueSources; }, string>

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

All subcomponents receive the configuration schema as a prop.

Inherited from

ActionWithRulesProps.schema

---

testID?

optional testID: string

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

Test ID for this component.

Inherited from

ActionWithRulesProps.testID

---

title?

optional title: string

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

The title/tooltip for this control.

Inherited from

ActionWithRulesProps.title

---

validation?

optional validation: boolean | ValidationResult

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

Validation result of the parent rule/group.

Inherited from

ActionWithRulesProps.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.