QueryBuilderFlags

Defined in: packages/core/src/types/queryBuilder.ts:297

Extended by

• UseMergedContext
• QueryBuilderContextProps

Properties

addRuleToNewGroups?

optional addRuleToNewGroups: boolean

Defined in: packages/core/src/types/queryBuilder.ts:389

Adds a new default rule automatically to each new group.

Default

false

---

autoSelectField?

optional autoSelectField: boolean

Defined in: packages/core/src/types/queryBuilder.ts:371

Select the first field in the array automatically.

Default

true

---

autoSelectOperator?

optional autoSelectOperator: boolean

Defined in: packages/core/src/types/queryBuilder.ts:377

Select the first operator in the array automatically.

Default

true

---

autoSelectValue?

optional autoSelectValue: boolean

Defined in: packages/core/src/types/queryBuilder.ts:383

Select the first value in the array automatically. Only applicable when the value editor renders a select list.

Default

false

---

debugMode?

optional debugMode: boolean

Defined in: packages/core/src/types/queryBuilder.ts:316

Enables debug logging for query builders (and React DnD when applicable).

Default

false

---

enableDragAndDrop?

optional enableDragAndDrop: boolean

Defined in: packages/core/src/types/queryBuilder.ts:310

Enables drag-and-drop features.

Default

false

---

enableMountQueryChange?

optional enableMountQueryChange: boolean

Defined in: packages/core/src/types/queryBuilder.ts:304

Set to false to avoid calling the onQueryChange callback when the component mounts.

Default

true

---

listsAsArrays?

optional listsAsArrays: boolean

Defined in: packages/core/src/types/queryBuilder.ts:395

Store list-type values as native arrays instead of comma-separated strings.

Default

false

---

resetOnFieldChange?

optional resetOnFieldChange: boolean

Defined in: packages/core/src/types/queryBuilder.ts:359

Reset the operator and value when the field changes.

Default

true

---

resetOnOperatorChange?

optional resetOnOperatorChange: boolean

Defined in: packages/core/src/types/queryBuilder.ts:365

Reset the value when the operator changes.

Default

false

---

showCloneButtons?

optional showCloneButtons: boolean

Defined in: packages/core/src/types/queryBuilder.ts:341

Show the "Clone rule" and "Clone group" buttons.

Default

false

---

showCombinatorsBetweenRules?

optional showCombinatorsBetweenRules: boolean

Defined in: packages/core/src/types/queryBuilder.ts:323

Show group combinator selectors in the body of the group, between each child rule/group, instead of in the group header.

Default

false

---

showLockButtons?

optional showLockButtons: boolean

Defined in: packages/core/src/types/queryBuilder.ts:347

Show the "Lock rule" and "Lock group" buttons.

Default

false

---

showMuteButtons?

optional showMuteButtons: boolean

Defined in: packages/core/src/types/queryBuilder.ts:353

Show the "Mute rule" and "Mute group" buttons.

Default

false

---

showNotToggle?

optional showNotToggle: boolean

Defined in: packages/core/src/types/queryBuilder.ts:329

Show the "not" (aka inversion) toggle for rule groups.

Default

false

---

showShiftActions?

optional showShiftActions: boolean

Defined in: packages/core/src/types/queryBuilder.ts:335

Show the "Shift up"/"Shift down" actions.

Default

false

---

suppressStandardClassnames?

optional suppressStandardClassnames: boolean

Defined in: packages/core/src/types/queryBuilder.ts:402

Prevent any assignment of standard classes to elements. This includes conditional and event-based classes for validation, drag-and-drop, etc.

Default

false

---

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.