QueryActionCallbacks

Defined in: packages/core/src/utils/queryActions.ts:32

Confirmation callbacks invoked before a mutation is applied. Their return values are interpreted differently depending on the operation:

• onAddRule/onAddGroup may return true to proceed, a falsy value to cancel, or a replacement rule/group to add instead of the one provided.
• onMoveRule/onMoveGroup/onGroupRule/onGroupGroup may return true to proceed, a falsy value to cancel, or a replacement query to apply instead of the computed one.
• onUngroup may return true to proceed, a falsy value to cancel, or a replacement query to apply instead of the computed one.
• onRemove is boolean only.

Extended by

• QueryActionsConfig

Properties

onAddGroup?

optional onAddGroup?: (ruleGroup: any, parentPath: Path, query: any, context?: any) => boolean | RuleGroupTypeAny

Defined in: packages/core/src/utils/queryActions.ts:34

Parameters

Parameter	Type
ruleGroup	any
parentPath	Path
query	any
context?	any

Returns

boolean | RuleGroupTypeAny

---

onAddRule?

optional onAddRule?: (rule: RuleType, parentPath: Path, query: any, context?: any) => boolean | RuleType<string, string, any, string, Record<string, any>>

Defined in: packages/core/src/utils/queryActions.ts:33

Parameters

Parameter	Type
rule	RuleType
parentPath	Path
query	any
context?	any

Returns

boolean | RuleType<string, string, any, string, Record<string, any>>

---

onGroupGroup?

optional onGroupGroup?: (...args: any[]) => boolean | RuleGroupTypeAny

Defined in: packages/core/src/utils/queryActions.ts:44

Parameters

Parameter	Type
...args	any[]

Returns

boolean | RuleGroupTypeAny

---

onGroupRule?

optional onGroupRule?: (...args: any[]) => boolean | RuleGroupTypeAny

Defined in: packages/core/src/utils/queryActions.ts:43

Parameters

Parameter	Type
...args	any[]

Returns

boolean | RuleGroupTypeAny

---

onMoveGroup?

optional onMoveGroup?: (...args: any[]) => boolean | RuleGroupTypeAny

Defined in: packages/core/src/utils/queryActions.ts:42

Parameters

Parameter	Type
...args	any[]

Returns

boolean | RuleGroupTypeAny

---

onMoveRule?

optional onMoveRule?: (...args: any[]) => boolean | RuleGroupTypeAny

Defined in: packages/core/src/utils/queryActions.ts:41

Parameters

Parameter	Type
...args	any[]

Returns

boolean | RuleGroupTypeAny

---

onRemove?

optional onRemove?: (ruleOrGroup: any, path: Path, query: any, context?: any) => boolean

Defined in: packages/core/src/utils/queryActions.ts:40

Parameters

Parameter	Type
ruleOrGroup	any
path	Path
query	any
context?	any

Returns

boolean

---

onUngroup?

optional onUngroup?: (...args: any[]) => boolean | RuleGroupTypeAny

Defined in: packages/core/src/utils/queryActions.ts:45

Parameters

Parameter	Type
...args	any[]

Returns

boolean | RuleGroupTypeAny

---

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.