Skip to main content

QueryBuilderContextProviderProps

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:555

Extends​

Extended by​

Properties​

children?​

optional children: ReactNode

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:557

controlClassnames?​

optional controlClassnames: Partial<Classnames>

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:532

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

Inherited from​

QueryBuilderContextProps.controlClassnames

controlElements?​

optional controlElements: 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; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; ... 9 more ...; className?: Clas..., operator: string) => boolean; defaultOperator: string; defaultValue: any; disabled: boolean; id: string; inputType: InputType | null | undefined; label: string; name: string; operators: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; placeholder: string; validator: RuleValidator; value: string; valueEditorType: ValueEditorType | ((operator: string) => ValueEditorType) | undefined; values: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; valueSources: ValueSources | ((operator: string) => ValueSources) | undefined; }>>; inlineCombinator: null | ComponentType<InlineCombinatorProps>; lockGroupAction: null | ComponentType<ActionWithRulesProps>; lockRuleAction: null | ComponentType<ActionWithRulesProps>; 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; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; ... 9 more ...; className?: Clas..., operator: string) => boolean; defaultOperator: string; defaultValue: any; disabled: boolean; id: string; inputType: null | InputType; label: string; name: string; operators: FlexibleOptionList<{[key: string]: unknown; disabled: boolean; label: string; name: string; value: string; }>; placeholder: string; validator: RuleValidator; value: string; valueEditorType: ValueEditorType | (operator: string) => ValueEditorType; values: FlexibleOptionList<{[key: string]: unknown; disabled: boolean; label: string; name: string; value: string; }>; valueSources: ValueSources | (operator: string) => ValueSources; }, 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; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; ... 9 more ...; className?: Clas..., operator: string) => boolean; defaultOperator: string; defaultValue: any; disabled: boolean; id: string; inputType: InputType | null | undefined; label: string; name: string; operators: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; placeholder: string; validator: RuleValidator; value: string; valueEditorType: ValueEditorType | ((operator: string) => ValueEditorType) | undefined; values: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; valueSources: ValueSources | ((operator: string) => ValueSources) | 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:520

Defines replacement components.

Inherited from​

QueryBuilderContextProps.controlElements

debugMode?​

optional debugMode: boolean

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:549

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

Default​

false

Inherited from​

QueryBuilderContextProps.debugMode

enableDragAndDrop?​

optional enableDragAndDrop: boolean

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:543

Enables drag-and-drop features.

Default​

false

Inherited from​

QueryBuilderContextProps.enableDragAndDrop

enableMountQueryChange?​

optional enableMountQueryChange: boolean

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:527

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

Default​

true

Inherited from​

QueryBuilderContextProps.enableMountQueryChange

translations?​

optional translations: Partial<Translations>

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:537

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

Inherited from​

QueryBuilderContextProps.translations

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.