Schema<F, O>

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

Configuration options passed in the schema prop from QueryBuilder to each subcomponent.

Note that this interface is invariant in F: a Schema<MyField, 'eq'> is not assignable to a Schema<FullField, string>, so passing one where the other is expected requires a cast. The cause is controls, whose members are ComponentType<…> properties and therefore contravariant in F, while fields/fieldMap are covariant in it. (The get* members are method shorthand, so their parameters compare bivariantly and contribute nothing.) TypeScript variance annotations cannot help here—in out asserts invariance rather than widening assignability—and removing the contravariance would mean narrowing the schema prop that custom controls receive, a breaking change. The behavior is pinned by props.test-d.ts.

Extended by

• SchemaNative

Type Parameters

Type Parameter
F extends FullField
O extends string

Methods

createRule()

createRule(): RuleType

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

Returns

RuleType

---

createRuleGroup()

createRuleGroup(ic?: boolean): RuleGroupTypeAny

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

Parameters

Parameter	Type
ic?	boolean

Returns

RuleGroupTypeAny

---

dispatchQuery()

dispatchQuery(query: RuleGroupTypeAny, options?: SetQueryStateOptions): void

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

Updates the query for this query builder in React Query Builder's internal Redux store, then calls the onQueryChange callback with the new query.

The optional options parameter augments the dispatched action's meta property. Pass { fromHistory: true } when applying a previously recorded query (e.g. from an undo/redo implementation) so that history recorders can ignore the update.

Parameters

Parameter	Type
query	RuleGroupTypeAny
options?	SetQueryStateOptions

Returns

void

---

getInputType()

getInputType(field: string, operator: string, meta: { fieldData: F; }): InputType | null

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

Parameters

Parameter	Type
field	string
operator	string
meta	{ fieldData: F; }
meta.fieldData	F

Returns

InputType | null

---

getMatchModes()

getMatchModes(field: string, misc: { fieldData: F; }): MatchModeOptions

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

Parameters

Parameter	Type
field	string
misc	{ fieldData: F; }
misc.fieldData	F

Returns

MatchModeOptions

---

getOperators()

getOperators(field: string, meta: { fieldData: F; }): FullOperator<string>[] | OptionGroup<FullOperator<string>>[]

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

Parameters

Parameter	Type
field	string
meta	{ fieldData: F; }
meta.fieldData	F

Returns

FullOperator<string>[] | OptionGroup<FullOperator<string>>[]

---

getParameters()

getParameters(field?: string, operator?: string, meta?: { fieldData: F; }): {[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }[] | OptionGroup<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>[]

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

Parameters

Parameter	Type
field?	string
operator?	string
meta?	{ fieldData: F; }
meta.fieldData?	F

Returns

{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }[] | OptionGroup<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>[]

---

getQuery()

getQuery(): RuleGroupTypeAny

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

Returns

RuleGroupTypeAny

---

getRuleClassname()

getRuleClassname(rule: RuleType, misc: { fieldData: F; }): Classname

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

Parameters

Parameter	Type
rule	RuleType
misc	{ fieldData: F; }
misc.fieldData	F

Returns

Classname

---

getRuleDefaultOperator()

getRuleDefaultOperator(field: string): string

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

Parameters

Parameter	Type
field	string

Returns

string

---

getRuleDefaultValue()

getRuleDefaultValue(rule: RuleType): unknown

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

Parameters

Parameter	Type
rule	RuleType

Returns

unknown

---

getRuleGroupClassname()

getRuleGroupClassname(ruleGroup: RuleGroupTypeAny): Classname

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

Parameters

Parameter	Type
ruleGroup	RuleGroupTypeAny

Returns

Classname

---

getSubQueryBuilderProps()

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

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

Parameters

Parameter	Type
field	GetOptionIdentifierType<F>
misc	{ fieldData: F; }
misc.fieldData	F

Returns

QueryBuilderContextProps<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }, string> & { accessibleDescriptionGenerator?: AccessibleDescriptionGenerator; baseCombinator?: Record<string, unknown>; baseField?: Record<string, unknown>; baseOperator?: Record<string, unknown>; combinators?: FlexibleOptionListProp<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; context?: any; defaultQuery?: RuleGroupType<RuleType<string, string, any, string, Record<string, any>>, string>; disabled?: boolean | Path[]; fields?: FlexibleOptionListProp<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }> | BaseOptionMap<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; getDefaultField?: string | ((fieldsData: {[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }[] | OptionGroup<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>[]) => string); getDefaultOperator?: string | ((field: string, misc: { fieldData: {[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }; }) => string); idGenerator?: () => string; independentCombinators?: boolean; maxLevels?: number; operators?: FlexibleOptionListProp<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; parseNumbers?: ParseNumbersPropConfig; qbId?: string; query?: RuleGroupType<RuleType<string, string, any, string, Record<string, any>>, string>; validator?: QueryValidator; getDefaultValue?: any; getInputType?: InputType | null; getMatchModes?: boolean | MatchMode[] | FlexibleOption<MatchMode>[]; getOperators?: FlexibleOptionListProp<FullOperator<string>> | null; getParameters?: FlexibleOptionListProp<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; getRuleClassname?: Classname; getRuleGroupClassname?: Classname; getSubQueryBuilderProps?: QueryBuilderContextProps<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }, string> & { accessibleDescriptionGenerator?: AccessibleDescriptionGenerator; baseCombinator?: Record<string, unknown>; baseField?: Record<string, unknown>; baseOperator?: Record<string, unknown>; combinators?: FlexibleOptionListProp<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; context?: any; defaultQuery?: RuleGroupType<RuleType<string, string, any, string, Record<string, any>>, string>; disabled?: boolean | Path[]; fields?: FlexibleOptionListProp<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }> | BaseOptionMap<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; getDefaultField?: string | ((fieldsData: OptionGroup<{[key: ...]: ...; disabled?: ...; label: ...; name: ...; value: ...; }>[] | {[key: string]: unknown; disabled?: ... | ... | ...; label: string; name: string; value: string; }[]) => string); getDefaultOperator?: string | ((field: string, misc: { fieldData: {[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }; }) => string); idGenerator?: () => string; independentCombinators?: boolean; maxLevels?: number; operators?: FlexibleOptionListProp<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; parseNumbers?: ParseNumbersPropConfig; qbId?: string; query?: RuleGroupType<RuleType<string, string, any, string, Record<string, any>>, string>; validator?: QueryValidator; getDefaultValue?: any; getInputType?: InputType | null; getMatchModes?: boolean | MatchMode[] | FlexibleOption<MatchMode>[]; getOperators?: FlexibleOptionListProp<FullOperator<string>> | null; getParameters?: FlexibleOptionListProp<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; getRuleClassname?: Classname; getRuleGroupClassname?: Classname; getSubQueryBuilderProps?: QueryBuilderContextProps<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }, string> & { qbId?: string | undefined; ... 38 more ...; context?: any; }; getValueEditorSeparator?: ReactNode; getValueEditorType?: ValueEditorType; getValues?: FlexibleOptionListProp<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value?: string; }>; getValueSources?: ValueSources | [FlexibleOption, ...FlexibleOption[]]; onAddGroup?: boolean | RuleGroupType<RuleType<string, string, any, string, Record<string, any>>, string>; onAddRule?: boolean | RuleType<string, string, any, string, Record<string, any>>; onGroupGroup?: boolean | RuleGroupType<RuleType<string, string, any, string, Record<string, any>>, string>; onGroupRule?: boolean | RuleGroupType<RuleType<string, string, any, string, Record<string, any>>, string>; onLog?: void; onMoveGroup?: boolean | RuleGroupType<RuleType<string, string, any, string, Record<string, any>>, string>; onMoveRule?: boolean | RuleGroupType<RuleType<string, string, any, string, Record<string, any>>, string>; onQueryChange?: void; onRemove?: boolean; }; getValueEditorSeparator?: ReactNode; getValueEditorType?: ValueEditorType; getValues?: FlexibleOptionListProp<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value?: string; }>; getValueSources?: ValueSources | [FlexibleOption, ...FlexibleOption[]]; onAddGroup?: boolean | RuleGroupType<RuleType<string, string, any, string, Record<string, any>>, string>; onAddRule?: boolean | RuleType<string, string, any, string, Record<string, any>>; onGroupGroup?: boolean | RuleGroupType<RuleType<string, string, any, string, Record<string, any>>, string>; onGroupRule?: boolean | RuleGroupType<RuleType<string, string, any, string, Record<string, any>>, string>; onLog?: void; onMoveGroup?: boolean | RuleGroupType<RuleType<string, string, any, string, Record<string, any>>, string>; onMoveRule?: boolean | RuleGroupType<RuleType<string, string, any, string, Record<string, any>>, string>; onQueryChange?: void; onRemove?: boolean; }

---

QueryBuilderContextProps<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }, string> & { accessibleDescriptionGenerator?: AccessibleDescriptionGenerator; baseCombinator?: Record<string, unknown>; baseField?: Record<string, unknown>; baseOperator?: Record<string, unknown>; combinators?: FlexibleOptionListProp<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; context?: any; defaultQuery?: RuleGroupTypeIC<RuleType<string, string, any, string, Record<string, any>>, string>; disabled?: boolean | Path[]; fields?: FlexibleOptionListProp<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }> | BaseOptionMap<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; getDefaultField?: string | ((fieldsData: {[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }[] | OptionGroup<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>[]) => string); getDefaultOperator?: string | ((field: string, misc: { fieldData: {[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }; }) => string); idGenerator?: () => string; independentCombinators?: boolean; maxLevels?: number; operators?: FlexibleOptionListProp<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; parseNumbers?: ParseNumbersPropConfig; qbId?: string; query?: RuleGroupTypeIC<RuleType<string, string, any, string, Record<string, any>>, string>; validator?: QueryValidator; getDefaultValue?: any; getInputType?: InputType | null; getMatchModes?: boolean | MatchMode[] | FlexibleOption<MatchMode>[]; getOperators?: FlexibleOptionListProp<FullOperator<string>> | null; getParameters?: FlexibleOptionListProp<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; getRuleClassname?: Classname; getRuleGroupClassname?: Classname; getSubQueryBuilderProps?: QueryBuilderContextProps<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }, string> & { accessibleDescriptionGenerator?: AccessibleDescriptionGenerator; baseCombinator?: Record<string, unknown>; baseField?: Record<string, unknown>; baseOperator?: Record<string, unknown>; combinators?: FlexibleOptionListProp<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; context?: any; defaultQuery?: RuleGroupTypeIC<RuleType<string, string, any, string, Record<string, any>>, string>; disabled?: boolean | Path[]; fields?: FlexibleOptionListProp<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }> | BaseOptionMap<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; getDefaultField?: string | ((fieldsData: OptionGroup<{[key: ...]: ...; disabled?: ...; label: ...; name: ...; value: ...; }>[] | {[key: string]: unknown; disabled?: ... | ... | ...; label: string; name: string; value: string; }[]) => string); getDefaultOperator?: string | ((field: string, misc: { fieldData: {[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }; }) => string); idGenerator?: () => string; independentCombinators?: boolean; maxLevels?: number; operators?: FlexibleOptionListProp<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; parseNumbers?: ParseNumbersPropConfig; qbId?: string; query?: RuleGroupTypeIC<RuleType<string, string, any, string, Record<string, any>>, string>; validator?: QueryValidator; getDefaultValue?: any; getInputType?: InputType | null; getMatchModes?: boolean | MatchMode[] | FlexibleOption<MatchMode>[]; getOperators?: FlexibleOptionListProp<FullOperator<string>> | null; getParameters?: FlexibleOptionListProp<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; getRuleClassname?: Classname; getRuleGroupClassname?: Classname; getSubQueryBuilderProps?: QueryBuilderContextProps<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }, string> & { qbId?: string | undefined; ... 38 more ...; context?: any; }; getValueEditorSeparator?: ReactNode; getValueEditorType?: ValueEditorType; getValues?: FlexibleOptionListProp<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value?: string; }>; getValueSources?: ValueSources | [FlexibleOption, ...FlexibleOption[]]; onAddGroup?: boolean | RuleGroupTypeIC<RuleType<string, string, any, string, Record<string, any>>, string>; onAddRule?: boolean | RuleType<string, string, any, string, Record<string, any>>; onGroupGroup?: boolean | RuleGroupTypeIC<RuleType<string, string, any, string, Record<string, any>>, string>; onGroupRule?: boolean | RuleGroupTypeIC<RuleType<string, string, any, string, Record<string, any>>, string>; onLog?: void; onMoveGroup?: boolean | RuleGroupTypeIC<RuleType<string, string, any, string, Record<string, any>>, string>; onMoveRule?: boolean | RuleGroupTypeIC<RuleType<string, string, any, string, Record<string, any>>, string>; onQueryChange?: void; onRemove?: boolean; }; getValueEditorSeparator?: ReactNode; getValueEditorType?: ValueEditorType; getValues?: FlexibleOptionListProp<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value?: string; }>; getValueSources?: ValueSources | [FlexibleOption, ...FlexibleOption[]]; onAddGroup?: boolean | RuleGroupTypeIC<RuleType<string, string, any, string, Record<string, any>>, string>; onAddRule?: boolean | RuleType<string, string, any, string, Record<string, any>>; onGroupGroup?: boolean | RuleGroupTypeIC<RuleType<string, string, any, string, Record<string, any>>, string>; onGroupRule?: boolean | RuleGroupTypeIC<RuleType<string, string, any, string, Record<string, any>>, string>; onLog?: void; onMoveGroup?: boolean | RuleGroupTypeIC<RuleType<string, string, any, string, Record<string, any>>, string>; onMoveRule?: boolean | RuleGroupTypeIC<RuleType<string, string, any, string, Record<string, any>>, string>; onQueryChange?: void; onRemove?: boolean; }

---

getValueEditorSeparator()

getValueEditorSeparator(field: string, operator: string, meta: { fieldData: F; }): ReactNode

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

Parameters

Parameter	Type
field	string
operator	string
meta	{ fieldData: F; }
meta.fieldData	F

Returns

ReactNode

---

getValueEditorType()

getValueEditorType(field: string, operator: string, meta: { fieldData: F; }): ValueEditorType

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

Parameters

Parameter	Type
field	string
operator	string
meta	{ fieldData: F; }
meta.fieldData	F

Returns

ValueEditorType

---

getValues()

getValues(field: string, operator: string, meta: { fieldData: F; }): WithUnknownIndex<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value?: string; } & {[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>[] | OptionGroup<WithUnknownIndex<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value?: string; } & {[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>>[]

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

Parameters

Parameter	Type
field	string
operator	string
meta	{ fieldData: F; }
meta.fieldData	F

Returns

WithUnknownIndex<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value?: string; } & {[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>[] | OptionGroup<WithUnknownIndex<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value?: string; } & {[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>>[]

---

getValueSources()

getValueSources(field: string, operator: string, meta: { fieldData: F; }): [{ label: string; name: ValueSource; value: ValueSource; }, ...{ label: string; name: ValueSource; value: ValueSource }[]]

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

Parameters

Parameter	Type
field	string
operator	string
meta	{ fieldData: F; }
meta.fieldData	F

Returns

[{ label: string; name: ValueSource; value: ValueSource; }, ...{ label: string; name: ValueSource; value: ValueSource }[]]

Properties

accessibleDescriptionGenerator

accessibleDescriptionGenerator: AccessibleDescriptionGenerator

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

---

addRuleToNewGroups

addRuleToNewGroups: boolean

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

---

autoSelectField

autoSelectField: boolean

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

---

autoSelectOperator

autoSelectOperator: boolean

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

---

autoSelectValue

autoSelectValue: boolean

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

---

classNames

classNames: Classnames

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

---

combinators

combinators: FullCombinator[] | OptionGroup<FullCombinator>[]

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

---

controls

controls: Controls<F, O>

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

---

disabledPaths

disabledPaths: Path[]

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

---

enableDragAndDrop

enableDragAndDrop: boolean

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

---

fieldMap

fieldMap: Partial<Record<GetOptionIdentifierType<F>, F>>

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

---

fields

fields: FullOptionList<F>

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

---

independentCombinators

independentCombinators: boolean

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

---

listsAsArrays

listsAsArrays: boolean

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

---

maxLevels

maxLevels: number

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

---

parseNumbers

parseNumbers: ParseNumbersPropConfig

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

---

qbId

qbId: string

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

---

resetOnFieldChange

resetOnFieldChange: boolean

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

---

resetOnOperatorChange

resetOnOperatorChange: boolean

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

---

showCloneButtons

showCloneButtons: boolean

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

---

showCombinatorsBetweenRules

showCombinatorsBetweenRules: boolean

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

---

showLockButtons

showLockButtons: boolean

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

---

showMuteButtons

showMuteButtons: boolean

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

---

showNotToggle

showNotToggle: boolean

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

---

showShiftActions

showShiftActions: boolean

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

---

showUndoRedo

showUndoRedo: boolean

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

---

suppressStandardClassnames

suppressStandardClassnames: boolean

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

---

validationMap

validationMap: ValidationMap

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

---

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.