QueryBuilderContextProps<F, O>
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:756
Props passed down through context from a QueryBuilderContextProvider.
Extended by
Type Parameters
Type Parameter |
---|
F extends FullField |
O extends string |
Properties
controlClassnames?
optional
controlClassnames:Partial
<Classnames
>
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:772
This can be used to assign specific CSS classes to various controls that are rendered by QueryBuilder.
controlElements?
optional
controlElements:Partial
<{actionElement
:ComponentType
<ActionProps
>;addGroupAction
:null
|ComponentType
<ActionProps
>;addRuleAction
:null
|ComponentType
<ActionProps
>;cloneGroupAction
:null
|ComponentType
<ActionProps
>;cloneRuleAction
:null
|ComponentType
<ActionProps
>;combinatorSelector
:null
|ComponentType
<CombinatorSelectorProps
>;dragHandle
:null
|ForwardRefExoticComponent
<DragHandleProps
&RefAttributes
<HTMLElement
>>;fieldSelector
:null
|ComponentType
<FieldSelectorProps
<F
>>;inlineCombinator
:null
|ComponentType
<InlineCombinatorProps
>;lockGroupAction
:null
|ComponentType
<ActionProps
>;lockRuleAction
:null
|ComponentType
<ActionProps
>;matchModeEditor
:null
|ComponentType
<MatchModeEditorProps
>;notToggle
:null
|ComponentType
<NotToggleProps
>;operatorSelector
:null
|ComponentType
<OperatorSelectorProps
>;removeGroupAction
:null
|ComponentType
<ActionProps
>;removeRuleAction
:null
|ComponentType
<ActionProps
>;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
:null
|ComponentType
<ShiftActionsProps
>;valueEditor
:null
|ComponentType
<ValueEditorProps
<F
,O
>>;valueSelector
:ComponentType
<ValueSelectorProps
<{[key
:string
]:unknown
;disabled?
:boolean
;label
:string
;name
:string
;value
:string
; }>>;valueSourceSelector
:null
|ComponentType
<ValueSourceSelectorProps
>; }>
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:760
Defines replacement components.
debugMode?
optional
debugMode:boolean
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:789
Enables debug logging for QueryBuilder (and React DnD when applicable).
Default
false
enableDragAndDrop?
optional
enableDragAndDrop:boolean
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:783
Enables drag-and-drop features.
Default
false
enableMountQueryChange?
optional
enableMountQueryChange:boolean
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:767
Set to false
to avoid calling the onQueryChange
callback
when the component mounts.
Default
true
translations?
optional
translations:Partial
<Translations
>
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:777
This can be used to override translatable texts applied to the various controls that are rendered by QueryBuilder.
API documentation is generated from the latest commit on the main
branch. It may be somewhat inconsistent with official releases of React Query Builder.