UseMergedContext<F, O, Finalize>
Defined in: packages/react-querybuilder/src/hooks/useMergedContext.ts:44
Props passed down through context from a QueryBuilderContextProvider.
Extends
Type Parameters
| Type Parameter | Default type |
|---|---|
F extends FullField | FullField |
O extends string | string |
Finalize extends boolean | undefined | undefined |
Properties
addRuleToNewGroups?
optionaladdRuleToNewGroups:boolean
Defined in: packages/core/src/types/queryBuilder.ts:385
Adds a new default rule automatically to each new group.
Default
false
Inherited from
QueryBuilderContextProps.addRuleToNewGroups
autoSelectField?
optionalautoSelectField:boolean
Defined in: packages/core/src/types/queryBuilder.ts:367
Select the first field in the array automatically.
Default
true
Inherited from
QueryBuilderContextProps.autoSelectField
autoSelectOperator?
optionalautoSelectOperator:boolean
Defined in: packages/core/src/types/queryBuilder.ts:373
Select the first operator in the array automatically.
Default
true
Inherited from
QueryBuilderContextProps.autoSelectOperator
autoSelectValue?
optionalautoSelectValue:boolean
Defined in: packages/core/src/types/queryBuilder.ts:379
Select the first value in the array automatically. Only applicable when the value editor renders a select list.
Default
false
Inherited from
QueryBuilderContextProps.autoSelectValue
controlClassnames
controlClassnames:
Classnames
Defined in: packages/react-querybuilder/src/hooks/useMergedContext.ts:54
This can be used to assign specific CSS classes to various controls that are rendered by QueryBuilder.
Overrides
QueryBuilderContextProps.controlClassnames
controlElements
controlElements:
Finalizeextendstrue?Required<SetNonNullable<Partial<{actionElement:ComponentType<ActionProps>;addGroupAction:ComponentType<ActionProps> |null;addRuleAction:ComponentType<ActionProps> |null;cloneGroupAction:ComponentType<ActionProps> |null;cloneRuleAction:ComponentType<ActionProps> |null;combinatorSelector:ComponentType<CombinatorSelectorProps> |null;dragHandle:ForwardRefExoticComponent<DragHandleProps&RefAttributes<HTMLElement>> |null;fieldSelector:ComponentType<FieldSelectorProps<F>> |null;inlineCombinator:ComponentType<InlineCombinatorProps> |null;lockGroupAction:ComponentType<ActionProps> |null;lockRuleAction:ComponentType<ActionProps> |null;matchModeEditor:ComponentType<MatchModeEditorProps> |null;muteGroupAction:ComponentType<ActionProps> |null;muteRuleAction:ComponentType<ActionProps> |null;notToggle:ComponentType<NotToggleProps> |null;operatorSelector:ComponentType<OperatorSelectorProps> |null;removeGroupAction:ComponentType<ActionProps> |null;removeRuleAction:ComponentType<ActionProps> |null;rule:ComponentType<RuleProps<string,string>>;ruleGroup:ComponentType<RuleGroupProps<F,O>>;ruleGroupBodyElements:ComponentType<RuleGroupProps<{[key:string]:unknown;disabled?:boolean;label:string;name:string;value:string; },string> &UseRuleGroup>;ruleGroupHeaderElements:ComponentType<RuleGroupProps<{[key:string]:unknown;disabled?:boolean;label:string;name:string;value:string; },string> &UseRuleGroup>;shiftActions:ComponentType<ShiftActionsProps> |null;valueEditor:ComponentType<ValueEditorProps<F,O>> |null;valueSelector:ComponentType<ValueSelectorProps<{[key:string]:unknown;disabled?:boolean;label:string;name:string;value:string; }>>;valueSourceSelector:ComponentType<ValueSourceSelectorProps> |null; }>,"rule"|"ruleGroup"|"inlineCombinator"|"notToggle"|"dragHandle"|"valueSourceSelector"|"shiftActions"|"actionElement"|"valueSelector"|"addGroupAction"|"addRuleAction"|"cloneGroupAction"|"cloneRuleAction"|"combinatorSelector"|"fieldSelector"|"lockGroupAction"|"lockRuleAction"|"muteGroupAction"|"muteRuleAction"|"matchModeEditor"|"operatorSelector"|"removeGroupAction"|"removeRuleAction"|"ruleGroupBodyElements"|"ruleGroupHeaderElements"|"valueEditor">> :Partial<Required<SetNonNullable<Partial<{actionElement:ComponentType<ActionProps>;addGroupAction:ComponentType<ActionProps> |null;addRuleAction:ComponentType<ActionProps> |null;cloneGroupAction:ComponentType<ActionProps> |null;cloneRuleAction:ComponentType<ActionProps> |null;combinatorSelector:ComponentType<CombinatorSelectorProps> |null;dragHandle:ForwardRefExoticComponent<DragHandleProps&RefAttributes<HTMLElement>> |null;fieldSelector:ComponentType<FieldSelectorProps<F>> |null;inlineCombinator:ComponentType<InlineCombinatorProps> |null;lockGroupAction:ComponentType<ActionProps> |null;lockRuleAction:ComponentType<ActionProps> |null;matchModeEditor:ComponentType<MatchModeEditorProps> |null;muteGroupAction:ComponentType<ActionProps> |null;muteRuleAction:ComponentType<ActionProps> |null;notToggle:ComponentType<NotToggleProps> |null;operatorSelector:ComponentType<OperatorSelectorProps> |null;removeGroupAction:ComponentType<ActionProps> |null;removeRuleAction:ComponentType<ActionProps> |null;rule:ComponentType<RuleProps<string,string>>;ruleGroup:ComponentType<RuleGroupProps<F,O>>;ruleGroupBodyElements:ComponentType<RuleGroupProps<{[key:string]:unknown;disabled?: ... | ... | ...;label:string;name:string;value:string; },string> &UseRuleGroup>;ruleGroupHeaderElements:ComponentType<RuleGroupProps<{[key:string]:unknown;disabled?: ... | ... | ...;label:string;name:string;value:string; },string> &UseRuleGroup>;shiftActions:ComponentType<ShiftActionsProps> |null;valueEditor:ComponentType<ValueEditorProps<F,O>> |null;valueSelector:ComponentType<ValueSelectorProps<{[key:string]:unknown;disabled?:boolean;label:string;name:string;value:string; }>>;valueSourceSelector:ComponentType<ValueSourceSelectorProps> |null; }>,"rule"|"ruleGroup"|"inlineCombinator"|"notToggle"|"dragHandle"|"valueSourceSelector"|"shiftActions"|"actionElement"|"valueSelector"|"addGroupAction"|"addRuleAction"|"cloneGroupAction"|"cloneRuleAction"|"combinatorSelector"|"fieldSelector"|"lockGroupAction"|"lockRuleAction"|"muteGroupAction"|"muteRuleAction"|"matchModeEditor"|"operatorSelector"|"removeGroupAction"|"removeRuleAction"|"ruleGroupBodyElements"|"ruleGroupHeaderElements"|"valueEditor">>>
Defined in: packages/react-querybuilder/src/hooks/useMergedContext.ts:53
Defines replacement components.
Overrides
QueryBuilderContextProps.controlElements
debugMode?
optionaldebugMode:boolean
Defined in: packages/core/src/types/queryBuilder.ts:312
Enables debug logging for query builders (and React DnD when applicable).
Default
false
Inherited from
QueryBuilderContextProps.debugMode
enableDragAndDrop
enableDragAndDrop:
Finalizeextendstrue?boolean:boolean|undefined
Defined in: packages/react-querybuilder/src/hooks/useMergedContext.ts:50
Enables drag-and-drop features.
Default
false
Overrides
QueryBuilderContextProps.enableDragAndDrop
enableMountQueryChange?
optionalenableMountQueryChange:boolean
Defined in: packages/core/src/types/queryBuilder.ts:300
Set to false to avoid calling the onQueryChange callback
when the component mounts.
Default
true
Inherited from
QueryBuilderContextProps.enableMountQueryChange
initialQuery?
optionalinitialQuery:RuleGroupTypeAny
Defined in: packages/react-querybuilder/src/hooks/useMergedContext.ts:51
listsAsArrays?
optionallistsAsArrays:boolean
Defined in: packages/core/src/types/queryBuilder.ts:391
Store list-type values as native arrays instead of comma-separated strings.
Default
false
Inherited from
QueryBuilderContextProps.listsAsArrays
qbId?
optionalqbId:string
Defined in: packages/react-querybuilder/src/hooks/useMergedContext.ts:52
resetOnFieldChange?
optionalresetOnFieldChange:boolean
Defined in: packages/core/src/types/queryBuilder.ts:355
Reset the operator and value when the field changes.
Default
true
Inherited from
QueryBuilderContextProps.resetOnFieldChange
resetOnOperatorChange?
optionalresetOnOperatorChange:boolean
Defined in: packages/core/src/types/queryBuilder.ts:361
Reset the value when the operator changes.
Default
false
Inherited from
QueryBuilderContextProps.resetOnOperatorChange
showCloneButtons?
optionalshowCloneButtons:boolean
Defined in: packages/core/src/types/queryBuilder.ts:337
Show the "Clone rule" and "Clone group" buttons.
Default
false
Inherited from
QueryBuilderContextProps.showCloneButtons
showCombinatorsBetweenRules?
optionalshowCombinatorsBetweenRules:boolean
Defined in: packages/core/src/types/queryBuilder.ts:319
Show group combinator selectors in the body of the group, between each child rule/group, instead of in the group header.
Default
false
Inherited from
QueryBuilderContextProps.showCombinatorsBetweenRules
showLockButtons?
optionalshowLockButtons:boolean
Defined in: packages/core/src/types/queryBuilder.ts:343
Show the "Lock rule" and "Lock group" buttons.
Default
false
Inherited from
QueryBuilderContextProps.showLockButtons
showMuteButtons?
optionalshowMuteButtons:boolean
Defined in: packages/core/src/types/queryBuilder.ts:349
Show the "Mute rule" and "Mute group" buttons.
Default
false
Inherited from
QueryBuilderContextProps.showMuteButtons
showNotToggle?
optionalshowNotToggle:boolean
Defined in: packages/core/src/types/queryBuilder.ts:325
Show the "not" (aka inversion) toggle for rule groups.
Default
false
Inherited from
QueryBuilderContextProps.showNotToggle
showShiftActions?
optionalshowShiftActions:boolean
Defined in: packages/core/src/types/queryBuilder.ts:331
Show the "Shift up"/"Shift down" actions.
Default
false
Inherited from
QueryBuilderContextProps.showShiftActions
suppressStandardClassnames?
optionalsuppressStandardClassnames:boolean
Defined in: packages/core/src/types/queryBuilder.ts:398
Prevent any assignment of standard classes to elements. This includes conditional and event-based classes for validation, drag-and-drop, etc.
Default
false
Inherited from
QueryBuilderContextProps.suppressStandardClassnames
translations
translations:
Finalizeextendstrue?TranslationsFull:Partial<Translations>
Defined in: packages/react-querybuilder/src/hooks/useMergedContext.ts:55
This can be used to override translatable texts applied to the various controls that are rendered by QueryBuilder.
Overrides
QueryBuilderContextProps.translations
API documentation is generated from the latest commit on the main branch. It may be somewhat inconsistent with official releases of React Query Builder.