Skip to main content

QueryBuilderProps<RG, F, O, C>

QueryBuilderProps<RG, F, O, C> = RG extends RuleGroupType<infer R> | RuleGroupTypeIC<infer R> ? QueryBuilderContextProps<F, GetOptionIdentifierType<O>> & { accessibleDescriptionGenerator?: AccessibleDescriptionGenerator; baseCombinator?: Record<string, unknown>; baseField?: Record<string, unknown>; baseOperator?: Record<string, unknown>; combinators?: FlexibleOptionListProp<C>; context?: any; defaultQuery?: RG; disabled?: boolean | Path[]; fields?: FlexibleOptionListProp<F> | BaseOptionMap<F>; getDefaultField?: GetOptionIdentifierType<F> | (fieldsData: FullOptionList<F>) => string; getDefaultOperator?: GetOptionIdentifierType<O> | (field: GetOptionIdentifierType<F>, misc: { fieldData: F; }) => string; idGenerator?: () => string; independentCombinators?: boolean; maxLevels?: number; operators?: FlexibleOptionListProp<O>; parseNumbers?: ParseNumbersPropConfig; query?: RG; validator?: QueryValidator; getDefaultValue?: any; getInputType?: InputType | null; getMatchModes?: boolean | MatchMode[] | FlexibleOption<MatchMode>[]; getOperators?: FlexibleOptionListProp<FullOperator<string>> | null; getRuleClassname?: Classname; getRuleGroupClassname?: Classname; getSubQueryBuilderProps?: QueryBuilderProps<GenericizeRuleGroupType<RG<RG>>, {[key: string]: unknown; disabled?: boolean; label: string; name: N; value: N; }, {[key: string]: unknown; disabled?: boolean; label: string; name: N; value: N; }, {[key: string]: unknown; disabled?: boolean; label: string; name: N; value: N; }>; getValueEditorSeparator?: ReactNode; getValueEditorType?: ValueEditorType; getValues?: FlexibleOptionListProp<{[key: string]: unknown; disabled?: boolean; label: string; name: N; value?: N; }>; getValueSources?: ValueSources | ValueSourceFlexibleOptions; onAddGroup?: boolean | RG<RG>; onAddRule?: boolean | RuleType<string, string, any, string>; onGroupGroup?: boolean | RG<RG>; onGroupRule?: boolean | RG<RG>; onLog?: void; onMoveGroup?: boolean | RG<RG>; onMoveRule?: boolean | RG<RG>; onQueryChange?: void; onRemove?: boolean; } : never

Defined in: packages/react-querybuilder/src/types/props.ts:788

Props for QueryBuilder.

Notes:

  • Only one of query or defaultQuery should be provided. If query is present, then defaultQuery should be undefined and vice versa.
  • If rendered initially with a query prop, then query must be defined in every subsequent render or warnings will be logged (in non-production modes only).

Type Parameters​

Type ParameterDescription
RG extends RuleGroupTypeAnyThe type of the query object, inferred from either the query or defaultQuery prop. Must extend RuleGroupType or RuleGroupTypeIC.
F extends FullFieldThe field type (see Field).
O extends FullOperatorThe operator type (see Operator).
C extends FullCombinatorThe combinator type (see Combinator).
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.