QueryBuilderContextProviderProps
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:797
Extends
QueryBuilderContextProps<FullField,string>
Extended by
Properties
children?
optionalchildren:ReactNode
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:799
controlClassnames?
optionalcontrolClassnames:Partial<Classnames>
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:774
This can be used to assign specific CSS classes to various controls that are rendered by QueryBuilder.
Inherited from
QueryBuilderContextProps.controlClassnames
controlElements?
optionalcontrolElements:Partial<{actionElement:ComponentType<ActionProps>;addGroupAction:null|ComponentType<ActionWithRulesAndAddersProps>;addRuleAction:null|ComponentType<ActionWithRulesAndAddersProps>;cloneGroupAction:null|ComponentType<ActionWithRulesProps>;cloneRuleAction:null|ComponentType<ActionProps>;combinatorSelector:null|ComponentType<CombinatorSelectorProps>;dragHandle:null|ForwardRefExoticComponent<DragHandleProps&RefAttributes<HTMLElement>>;fieldSelector:null|ComponentType<FieldSelectorProps<{[key:string]:unknown;className?: Classname | undefined;comparator?:string| (f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | undefined; ... 11 more ...; className?: Classname | unde...,operator:string) =>boolean;defaultOperator?:string;defaultValue?:any;disabled?:boolean;id?:string;inputType?: InputType | null | undefined;label:string;matchModes?:boolean|MatchMode[] |FlexibleOption<MatchMode>[];name:string;operators?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | undefined;placeholder?:string;subproperties?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | undefined; ... 11 more ...; className...;validator?:RuleValidator;value:string;valueEditorType?: ValueEditorType | ((operator: string) => ValueEditorType) | undefined;values?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | undefined;valueSources?: ValueSources | ValueSourceFlexibleOptions | ((operator: string) => ValueSources | ValueSourceFlexibleOptions) | undefined; }>>;inlineCombinator:null|ComponentType<InlineCombinatorProps>;lockGroupAction:null|ComponentType<ActionWithRulesProps>;lockRuleAction:null|ComponentType<ActionWithRulesProps>;matchModeEditor:null|ComponentType<MatchModeEditorProps>;notToggle:null|ComponentType<NotToggleProps>;operatorSelector:null|ComponentType<OperatorSelectorProps>;removeGroupAction:null|ComponentType<ActionWithRulesProps>;removeRuleAction:null|ComponentType<ActionProps>;rule:ComponentType<RuleProps<string,string>>;ruleGroup:ComponentType<RuleGroupProps<{[key:string]:unknown;className?:Classname;comparator?:string| (f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | undefined; ... 11 more ...; className?: Classname | unde...,operator:string) =>boolean;defaultOperator?:string;defaultValue?:any;disabled?:boolean;id?:string;inputType?:null|InputType;label:string;matchModes?:boolean|MatchMode[] |FlexibleOption<MatchMode>[];name:string;operators?:FlexibleOptionList<{[key:string]:unknown;disabled?:boolean;label:string;name:string;value:string; }>;placeholder?:string;subproperties?:FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | undefined; ... 11 more ...; className?: Classname | unde...>;validator?:RuleValidator;value:string;valueEditorType?:ValueEditorType| (operator:string) =>ValueEditorType;values?:FlexibleOptionList<{[key:string]:unknown;disabled?:boolean;label:string;name:string;value:string; }>;valueSources?:ValueSources|ValueSourceFlexibleOptions| (operator:string) => ValueSources | ValueSourceFlexibleOptions; },string>>;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<{[key:string]:unknown;className?: Classname | undefined;comparator?:string| (f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | undefined; ... 11 more ...; className?: Classname | unde...,operator:string) =>boolean;defaultOperator?:string;defaultValue?:any;disabled?:boolean;id?:string;inputType?: InputType | null | undefined;label:string;matchModes?:boolean|MatchMode[] |FlexibleOption<MatchMode>[];name:string;operators?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | undefined;placeholder?:string;subproperties?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | undefined; ... 11 more ...; className...;validator?:RuleValidator;value:string;valueEditorType?: ValueEditorType | ((operator: string) => ValueEditorType) | undefined;values?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | undefined;valueSources?: ValueSources | ValueSourceFlexibleOptions | ((operator: string) => ValueSources | ValueSourceFlexibleOptions) | undefined; },string>>;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:762
Defines replacement components.
Inherited from
QueryBuilderContextProps.controlElements
debugMode?
optionaldebugMode:boolean
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:791
Enables debug logging for QueryBuilder (and React DnD when applicable).
Default
false
Inherited from
QueryBuilderContextProps.debugMode
enableDragAndDrop?
optionalenableDragAndDrop:boolean
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:785
Enables drag-and-drop features.
Default
false
Inherited from
QueryBuilderContextProps.enableDragAndDrop
enableMountQueryChange?
optionalenableMountQueryChange:boolean
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:769
Set to false to avoid calling the onQueryChange callback
when the component mounts.
Default
true
Inherited from
QueryBuilderContextProps.enableMountQueryChange
translations?
optionaltranslations:Partial<Translations>
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:779
This can be used to override translatable texts applied to the various controls that are rendered by QueryBuilder.
Inherited from
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.