QueryBuilderContextProps<F, O>

Props passed down through context from a QueryBuilderContextProvider.

Type Parameters

Type Parameter
F extends FullField
O extends string

Properties

controlClassnames?

optional controlClassnames: Partial<Classnames>

This can be used to assign specific CSS classes to various controls that are rendered by QueryBuilder.

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:493

---

controlElements?

optional controlElements: Partial<object>

Defines replacement components.

Type declaration

actionElement

actionElement: ComponentType<ActionProps>

Default component for all button-type controls.

Default

ActionElement

addGroupAction

addGroupAction: null | ComponentType<ActionWithRulesAndAddersProps>

Adds a sub-group to the current group.

Default

ActionElement

addRuleAction

addRuleAction: null | ComponentType<ActionWithRulesAndAddersProps>

Adds a rule to the current group.

Default

ActionElement

cloneGroupAction

cloneGroupAction: null | ComponentType<ActionWithRulesProps>

Clones the current group.

Default

ActionElement

cloneRuleAction

cloneRuleAction: null | ComponentType<ActionProps>

Clones the current rule.

Default

ActionElement

combinatorSelector

combinatorSelector: null | ComponentType<CombinatorSelectorProps>

Selects the combinator property for the current group, or the current independent combinator value.

Default

ValueSelector

dragHandle

dragHandle: null | ForwardRefExoticComponent<DragHandleProps & RefAttributes<HTMLElement>>

Provides a draggable handle for reordering rules and groups.

Default

DragHandle

fieldSelector

fieldSelector: null | ComponentType<FieldSelectorProps<F>>

Selects the field property for the current rule.

Default

ValueSelector

inlineCombinator

inlineCombinator: null | ComponentType<InlineCombinatorProps>

A small wrapper around the combinatorSelector component.

Default

InlineCombinator

lockGroupAction

lockGroupAction: null | ComponentType<ActionWithRulesProps>

Locks the current group (sets the disabled property to true).

Default

ActionElement

lockRuleAction

lockRuleAction: null | ComponentType<ActionWithRulesProps>

Locks the current rule (sets the disabled property to true).

Default

ActionElement

notToggle

notToggle: null | ComponentType<NotToggleProps>

Toggles the not property of the current group between true and false.

Default

NotToggle

operatorSelector

operatorSelector: null | ComponentType<OperatorSelectorProps>

Selects the operator property for the current rule.

Default

ValueSelector

removeGroupAction

removeGroupAction: null | ComponentType<ActionWithRulesProps>

Removes the current group from its parent group's rules array.

Default

ActionElement

removeRuleAction

removeRuleAction: null | ComponentType<ActionProps>

Removes the current rule from its parent group's rules array.

Default

ActionElement

rule

rule: ComponentType<RuleProps<string, string>>

Rule layout component.

Default

Rule

ruleGroup

ruleGroup: ComponentType<RuleGroupProps<F, O>>

Rule group layout component.

Default

RuleGroup

ruleGroupBodyElements

ruleGroupBodyElements: ComponentType<RuleGroupProps<FullOption<string>, string> & object>

Rule group body components.

Default

RuleGroupBodyComponents

ruleGroupHeaderElements

ruleGroupHeaderElements: ComponentType<RuleGroupProps<FullOption<string>, string> & object>

Rule group header components.

Default

RuleGroupHeaderComponents

shiftActions

shiftActions: null | ComponentType<ShiftActionsProps>

Shifts the current rule/group up or down in the query hierarchy.

Default

ShiftActions

valueEditor

valueEditor: null | ComponentType<ValueEditorProps<F, O>>

Updates the value property for the current rule.

Default

ValueEditor

valueSelector

valueSelector: ComponentType<ValueSelectorProps<FullOption<string>>>

Default component for all value selector controls.

Default

ValueSelector

valueSourceSelector

valueSourceSelector: null | ComponentType<ValueSourceSelectorProps>

Selects the valueSource property for the current rule.

Default

ValueSelector

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:481

---

debugMode?

optional debugMode: boolean

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

Default

false

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:510

---

enableDragAndDrop?

optional enableDragAndDrop: boolean

Enables drag-and-drop features.

Default

false

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:504

---

enableMountQueryChange?

optional enableMountQueryChange: boolean

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

Default

true

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:488

---

translations?

optional translations: Partial<Translations>

This can be used to override translatable texts applied to the various controls that are rendered by QueryBuilder.

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:498

---

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.