Skip to main content

AddOptions

Defined in: packages/core/src/utils/queryTools.ts:190

Options for add.

Extends​

Properties​

combinatorPreceding?​

optional combinatorPreceding?: string

Defined in: packages/core/src/utils/queryTools.ts:203

If the query extends RuleGroupTypeIC (i.e. the query has independent combinators), then this combinator will be inserted before the new rule/group if the parent group is not empty. This option will supersede combinators.

combinators?​

optional combinators?: OptionList

Defined in: packages/core/src/utils/queryTools.ts:197

If the query extends RuleGroupTypeIC (i.e. the query has independent combinators), then the first combinator in this list will be inserted before the new rule/group if the parent group is not empty. This option is overridden by combinatorPreceding.

disabledPaths?​

optional disabledPaths?: Path[]

Defined in: packages/core/src/utils/queryTools.ts:108

Paths that are disabled without the corresponding rule or group carrying a disabled property, mirroring the array form of the QueryBuilder disabled prop. A path is treated as disabled if it appears here or descends from a path that does.

Like the disabled property, this is only honored when respectDisabled is true, and updating a rule or group's own disabled property is still permitted.

Inherited from​

QueryToolOptions.disabledPaths

freeze?​

optional freeze?: boolean

Defined in: packages/core/src/utils/queryTools.ts:145

Set false to skip immer's auto-freeze on the returned query, e.g. when the query will be handed to a framework that wraps it in a proxy (Vue reactive, Solid stores) or otherwise needs to mutate it. Ignored by the *InPlace variants, which never freeze.

Default​

true

Inherited from​

QueryToolOptions.freeze

idGenerator?​

optional idGenerator?: () => string

Defined in: packages/core/src/utils/queryTools.ts:207

ID generator.

Returns​

string

maxLevels?​

optional maxLevels?: number

Defined in: packages/core/src/utils/queryTools.ts:115

The maximum depth at which a group may be added. A group whose parent path is already this deep is rejected by add and insert. Rules are unaffected. Defaults to Infinity.

Inherited from​

QueryToolOptions.maxLevels

onAbort?​

optional onAbort?: (info: AbortInfo) => void

Defined in: packages/core/src/utils/queryTools.ts:129

Called when the operation returns the query unmodified, with the reason why. Query tools never throw, so this is the only way to distinguish "the target was invalid" from "the operation had nothing to do".

Parameters​

ParameterType
infoAbortInfo

Returns​

void

Inherited from​

QueryToolOptions.onAbort

queryDisabled?​

optional queryDisabled?: boolean

Defined in: packages/core/src/utils/queryTools.ts:110

Abort every mutation, as though the entire query were disabled. Defaults to false.

Inherited from​

QueryToolOptions.queryDisabled

respectDisabled?​

optional respectDisabled?: boolean

Defined in: packages/core/src/utils/queryTools.ts:99

Abort when the target (or its parent, for add/insert) is disabled, either directly or by descending from a disabled group. Defaults to false.

Updating a rule or group's own disabled property is always permitted, since it is the only way to re-enable it.

Inherited from​

QueryToolOptions.respectDisabled

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.