Schema<F, O>

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

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

Extended by

• SchemaNative

Type Parameters

Type Parameter
F extends FullField
O extends string

Methods

createRule()

createRule(): RuleType

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

Returns

RuleType

---

createRuleGroup()

createRuleGroup(ic?: boolean): RuleGroupTypeAny

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

Parameters

Parameter	Type
ic?	boolean

Returns

RuleGroupTypeAny

---

dispatchQuery()

dispatchQuery(query: RuleGroupTypeAny): void

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

Parameters

Parameter	Type
query	RuleGroupTypeAny

Returns

void

---

getInputType()

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

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

Parameters

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

Returns

null | InputType

---

getMatchModes()

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

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

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/propsUsingReact.ts:642

Parameters

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

Returns

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

---

getQuery()

getQuery(): RuleGroupTypeAny

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

Returns

RuleGroupTypeAny

---

getRuleClassname()

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

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

Parameters

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

Returns

Classname

---

getRuleGroupClassname()

getRuleGroupClassname(ruleGroup: RuleGroupTypeAny): Classname

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

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; addRuleToNewGroups?: boolean; autoSelectField?: boolean; autoSelectOperator?: boolean; autoSelectValue?: boolean; baseCombinator?: Record<string, unknown>; baseField?: Record<string, unknown>; baseOperator?: Record<string, unknown>; combinators?: CombinatorOptions<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; context?: any; defaultQuery?: RuleGroupType<RuleType<string, string, any, string>, string>; disabled?: boolean | Path[]; fields?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }> | BaseOptionMap<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }, 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; listsAsArrays?: boolean; maxLevels?: number; operators?: OperatorOptions<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; parseNumbers?: ParseNumbersPropConfig; query?: RuleGroupType<RuleType<string, string, any, string>, string>; resetOnFieldChange?: boolean; resetOnOperatorChange?: boolean; showCloneButtons?: boolean; showCombinatorsBetweenRules?: boolean; showLockButtons?: boolean; showNotToggle?: boolean; showShiftActions?: boolean; suppressStandardClassnames?: boolean; validator?: QueryValidator; getDefaultValue?: any; getInputType?: null | InputType; getMatchModes?: boolean | MatchMode[] | FlexibleOption<MatchMode>[]; getOperators?: null | OperatorOptions<FullOperator<string>>; getRuleClassname?: Classname; getRuleGroupClassname?: Classname; getSubQueryBuilderProps?: QueryBuilderContextProps<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }, string> & { accessibleDescriptionGenerator?: AccessibleDescriptionGenerator; addRuleToNewGroups?: boolean; autoSelectField?: boolean; autoSelectOperator?: boolean; autoSelectValue?: boolean; baseCombinator?: Record<string, unknown>; baseField?: Record<string, unknown>; baseOperator?: Record<string, unknown>; combinators?: CombinatorOptions<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; context?: any; defaultQuery?: RuleGroupType<RuleType<string, string, any, string>, string>; disabled?: boolean | Path[]; fields?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }> | BaseOptionMap<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }, 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; listsAsArrays?: boolean; maxLevels?: number; operators?: OperatorOptions<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; parseNumbers?: ParseNumbersPropConfig; query?: RuleGroupType<RuleType<string, string, any, string>, string>; resetOnFieldChange?: boolean; resetOnOperatorChange?: boolean; showCloneButtons?: boolean; showCombinatorsBetweenRules?: boolean; showLockButtons?: boolean; showNotToggle?: boolean; showShiftActions?: boolean; suppressStandardClassnames?: boolean; validator?: QueryValidator; getDefaultValue?: any; getInputType?: null | InputType; getMatchModes?: boolean | MatchMode[] | FlexibleOption<MatchMode>[]; getOperators?: null | OperatorOptions<FullOperator<string>>; getRuleClassname?: Classname; getRuleGroupClassname?: Classname; getSubQueryBuilderProps?: QueryBuilderContextProps<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }, string> & { defaultQuery?: RuleGroupType<RuleType<string, string, any, string>, string> | undefined; ... 49 more ...; context?: any; }; getValueEditorSeparator?: ReactNode; getValueEditorType?: ValueEditorType; getValues?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value?: string; }>; getValueSources?: ValueSources | ValueSourceFlexibleOptions; onAddGroup?: boolean | RuleGroupType<RuleType<string, string, any, string>, string>; onAddRule?: boolean | RuleType<string, string, any, string>; onGroupGroup?: boolean | RuleGroupType<RuleType<string, string, any, string>, string>; onGroupRule?: boolean | RuleGroupType<RuleType<string, string, any, string>, string>; onLog?: void; onMoveGroup?: boolean | RuleGroupType<RuleType<string, string, any, string>, string>; onMoveRule?: boolean | RuleGroupType<RuleType<string, string, any, string>, string>; onQueryChange?: void; onRemove?: boolean; }; getValueEditorSeparator?: ReactNode; getValueEditorType?: ValueEditorType; getValues?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value?: string; }>; getValueSources?: ValueSources | ValueSourceFlexibleOptions; onAddGroup?: boolean | RuleGroupType<RuleType<string, string, any, string>, string>; onAddRule?: boolean | RuleType<string, string, any, string>; onGroupGroup?: boolean | RuleGroupType<RuleType<string, string, any, string>, string>; onGroupRule?: boolean | RuleGroupType<RuleType<string, string, any, string>, string>; onLog?: void; onMoveGroup?: boolean | RuleGroupType<RuleType<string, string, any, string>, string>; onMoveRule?: boolean | RuleGroupType<RuleType<string, string, any, string>, string>; onQueryChange?: void; onRemove?: boolean; } | QueryBuilderContextProps<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }, string> & { accessibleDescriptionGenerator?: AccessibleDescriptionGenerator; addRuleToNewGroups?: boolean; autoSelectField?: boolean; autoSelectOperator?: boolean; autoSelectValue?: boolean; baseCombinator?: Record<string, unknown>; baseField?: Record<string, unknown>; baseOperator?: Record<string, unknown>; combinators?: CombinatorOptions<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; context?: any; defaultQuery?: RuleGroupTypeIC<RuleType<string, string, any, string>, string>; disabled?: boolean | Path[]; fields?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }> | BaseOptionMap<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }, 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; listsAsArrays?: boolean; maxLevels?: number; operators?: OperatorOptions<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; parseNumbers?: ParseNumbersPropConfig; query?: RuleGroupTypeIC<RuleType<string, string, any, string>, string>; resetOnFieldChange?: boolean; resetOnOperatorChange?: boolean; showCloneButtons?: boolean; showCombinatorsBetweenRules?: boolean; showLockButtons?: boolean; showNotToggle?: boolean; showShiftActions?: boolean; suppressStandardClassnames?: boolean; validator?: QueryValidator; getDefaultValue?: any; getInputType?: null | InputType; getMatchModes?: boolean | MatchMode[] | FlexibleOption<MatchMode>[]; getOperators?: null | OperatorOptions<FullOperator<string>>; getRuleClassname?: Classname; getRuleGroupClassname?: Classname; getSubQueryBuilderProps?: QueryBuilderContextProps<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }, string> & { accessibleDescriptionGenerator?: AccessibleDescriptionGenerator; addRuleToNewGroups?: boolean; autoSelectField?: boolean; autoSelectOperator?: boolean; autoSelectValue?: boolean; baseCombinator?: Record<string, unknown>; baseField?: Record<string, unknown>; baseOperator?: Record<string, unknown>; combinators?: CombinatorOptions<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; context?: any; defaultQuery?: RuleGroupTypeIC<RuleType<string, string, any, string>, string>; disabled?: boolean | Path[]; fields?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }> | BaseOptionMap<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }, 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; listsAsArrays?: boolean; maxLevels?: number; operators?: OperatorOptions<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; parseNumbers?: ParseNumbersPropConfig; query?: RuleGroupTypeIC<RuleType<string, string, any, string>, string>; resetOnFieldChange?: boolean; resetOnOperatorChange?: boolean; showCloneButtons?: boolean; showCombinatorsBetweenRules?: boolean; showLockButtons?: boolean; showNotToggle?: boolean; showShiftActions?: boolean; suppressStandardClassnames?: boolean; validator?: QueryValidator; getDefaultValue?: any; getInputType?: null | InputType; getMatchModes?: boolean | MatchMode[] | FlexibleOption<MatchMode>[]; getOperators?: null | OperatorOptions<FullOperator<string>>; getRuleClassname?: Classname; getRuleGroupClassname?: Classname; getSubQueryBuilderProps?: QueryBuilderContextProps<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }, string> & { defaultQuery?: RuleGroupTypeIC<RuleType<string, string, any, string>, string> | undefined; ... 49 more ...; context?: any; }; getValueEditorSeparator?: ReactNode; getValueEditorType?: ValueEditorType; getValues?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value?: string; }>; getValueSources?: ValueSources | ValueSourceFlexibleOptions; onAddGroup?: boolean | RuleGroupTypeIC<RuleType<string, string, any, string>, string>; onAddRule?: boolean | RuleType<string, string, any, string>; onGroupGroup?: boolean | RuleGroupTypeIC<RuleType<string, string, any, string>, string>; onGroupRule?: boolean | RuleGroupTypeIC<RuleType<string, string, any, string>, string>; onLog?: void; onMoveGroup?: boolean | RuleGroupTypeIC<RuleType<string, string, any, string>, string>; onMoveRule?: boolean | RuleGroupTypeIC<RuleType<string, string, any, string>, string>; onQueryChange?: void; onRemove?: boolean; }; getValueEditorSeparator?: ReactNode; getValueEditorType?: ValueEditorType; getValues?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value?: string; }>; getValueSources?: ValueSources | ValueSourceFlexibleOptions; onAddGroup?: boolean | RuleGroupTypeIC<RuleType<string, string, any, string>, string>; onAddRule?: boolean | RuleType<string, string, any, string>; onGroupGroup?: boolean | RuleGroupTypeIC<RuleType<string, string, any, string>, string>; onGroupRule?: boolean | RuleGroupTypeIC<RuleType<string, string, any, string>, string>; onLog?: void; onMoveGroup?: boolean | RuleGroupTypeIC<RuleType<string, string, any, string>, string>; onMoveRule?: boolean | RuleGroupTypeIC<RuleType<string, string, any, string>, string>; onQueryChange?: void; onRemove?: boolean; }

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

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; addRuleToNewGroups?: boolean; autoSelectField?: boolean; autoSelectOperator?: boolean; autoSelectValue?: boolean; baseCombinator?: Record<string, unknown>; baseField?: Record<string, unknown>; baseOperator?: Record<string, unknown>; combinators?: CombinatorOptions<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; context?: any; defaultQuery?: RuleGroupType<RuleType<string, string, any, string>, string>; disabled?: boolean | Path[]; fields?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }> | BaseOptionMap<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }, 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; listsAsArrays?: boolean; maxLevels?: number; operators?: OperatorOptions<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; parseNumbers?: ParseNumbersPropConfig; query?: RuleGroupType<RuleType<string, string, any, string>, string>; resetOnFieldChange?: boolean; resetOnOperatorChange?: boolean; showCloneButtons?: boolean; showCombinatorsBetweenRules?: boolean; showLockButtons?: boolean; showNotToggle?: boolean; showShiftActions?: boolean; suppressStandardClassnames?: boolean; validator?: QueryValidator; getDefaultValue?: any; getInputType?: null | InputType; getMatchModes?: boolean | MatchMode[] | FlexibleOption<MatchMode>[]; getOperators?: null | OperatorOptions<FullOperator<string>>; getRuleClassname?: Classname; getRuleGroupClassname?: Classname; getSubQueryBuilderProps?: QueryBuilderContextProps<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }, string> & { accessibleDescriptionGenerator?: AccessibleDescriptionGenerator; addRuleToNewGroups?: boolean; autoSelectField?: boolean; autoSelectOperator?: boolean; autoSelectValue?: boolean; baseCombinator?: Record<string, unknown>; baseField?: Record<string, unknown>; baseOperator?: Record<string, unknown>; combinators?: CombinatorOptions<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; context?: any; defaultQuery?: RuleGroupType<RuleType<string, string, any, string>, string>; disabled?: boolean | Path[]; fields?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }> | BaseOptionMap<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }, 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; listsAsArrays?: boolean; maxLevels?: number; operators?: OperatorOptions<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; parseNumbers?: ParseNumbersPropConfig; query?: RuleGroupType<RuleType<string, string, any, string>, string>; resetOnFieldChange?: boolean; resetOnOperatorChange?: boolean; showCloneButtons?: boolean; showCombinatorsBetweenRules?: boolean; showLockButtons?: boolean; showNotToggle?: boolean; showShiftActions?: boolean; suppressStandardClassnames?: boolean; validator?: QueryValidator; getDefaultValue?: any; getInputType?: null | InputType; getMatchModes?: boolean | MatchMode[] | FlexibleOption<MatchMode>[]; getOperators?: null | OperatorOptions<FullOperator<string>>; getRuleClassname?: Classname; getRuleGroupClassname?: Classname; getSubQueryBuilderProps?: QueryBuilderContextProps<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }, string> & { defaultQuery?: RuleGroupType<RuleType<string, string, any, string>, string> | undefined; ... 49 more ...; context?: any; }; getValueEditorSeparator?: ReactNode; getValueEditorType?: ValueEditorType; getValues?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value?: string; }>; getValueSources?: ValueSources | ValueSourceFlexibleOptions; onAddGroup?: boolean | RuleGroupType<RuleType<string, string, any, string>, string>; onAddRule?: boolean | RuleType<string, string, any, string>; onGroupGroup?: boolean | RuleGroupType<RuleType<string, string, any, string>, string>; onGroupRule?: boolean | RuleGroupType<RuleType<string, string, any, string>, string>; onLog?: void; onMoveGroup?: boolean | RuleGroupType<RuleType<string, string, any, string>, string>; onMoveRule?: boolean | RuleGroupType<RuleType<string, string, any, string>, string>; onQueryChange?: void; onRemove?: boolean; }; getValueEditorSeparator?: ReactNode; getValueEditorType?: ValueEditorType; getValues?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value?: string; }>; getValueSources?: ValueSources | ValueSourceFlexibleOptions; onAddGroup?: boolean | RuleGroupType<RuleType<string, string, any, string>, string>; onAddRule?: boolean | RuleType<string, string, any, string>; onGroupGroup?: boolean | RuleGroupType<RuleType<string, string, any, string>, string>; onGroupRule?: boolean | RuleGroupType<RuleType<string, string, any, string>, string>; onLog?: void; onMoveGroup?: boolean | RuleGroupType<RuleType<string, string, any, string>, string>; onMoveRule?: boolean | RuleGroupType<RuleType<string, string, any, string>, string>; onQueryChange?: void; onRemove?: boolean; }

QueryBuilderContextProps<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }, string> & { accessibleDescriptionGenerator?: AccessibleDescriptionGenerator; addRuleToNewGroups?: boolean; autoSelectField?: boolean; autoSelectOperator?: boolean; autoSelectValue?: boolean; baseCombinator?: Record<string, unknown>; baseField?: Record<string, unknown>; baseOperator?: Record<string, unknown>; combinators?: CombinatorOptions<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; context?: any; defaultQuery?: RuleGroupTypeIC<RuleType<string, string, any, string>, string>; disabled?: boolean | Path[]; fields?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }> | BaseOptionMap<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }, 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; listsAsArrays?: boolean; maxLevels?: number; operators?: OperatorOptions<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; parseNumbers?: ParseNumbersPropConfig; query?: RuleGroupTypeIC<RuleType<string, string, any, string>, string>; resetOnFieldChange?: boolean; resetOnOperatorChange?: boolean; showCloneButtons?: boolean; showCombinatorsBetweenRules?: boolean; showLockButtons?: boolean; showNotToggle?: boolean; showShiftActions?: boolean; suppressStandardClassnames?: boolean; validator?: QueryValidator; getDefaultValue?: any; getInputType?: null | InputType; getMatchModes?: boolean | MatchMode[] | FlexibleOption<MatchMode>[]; getOperators?: null | OperatorOptions<FullOperator<string>>; getRuleClassname?: Classname; getRuleGroupClassname?: Classname; getSubQueryBuilderProps?: QueryBuilderContextProps<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }, string> & { accessibleDescriptionGenerator?: AccessibleDescriptionGenerator; addRuleToNewGroups?: boolean; autoSelectField?: boolean; autoSelectOperator?: boolean; autoSelectValue?: boolean; baseCombinator?: Record<string, unknown>; baseField?: Record<string, unknown>; baseOperator?: Record<string, unknown>; combinators?: CombinatorOptions<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; context?: any; defaultQuery?: RuleGroupTypeIC<RuleType<string, string, any, string>, string>; disabled?: boolean | Path[]; fields?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }> | BaseOptionMap<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }, 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; listsAsArrays?: boolean; maxLevels?: number; operators?: OperatorOptions<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; parseNumbers?: ParseNumbersPropConfig; query?: RuleGroupTypeIC<RuleType<string, string, any, string>, string>; resetOnFieldChange?: boolean; resetOnOperatorChange?: boolean; showCloneButtons?: boolean; showCombinatorsBetweenRules?: boolean; showLockButtons?: boolean; showNotToggle?: boolean; showShiftActions?: boolean; suppressStandardClassnames?: boolean; validator?: QueryValidator; getDefaultValue?: any; getInputType?: null | InputType; getMatchModes?: boolean | MatchMode[] | FlexibleOption<MatchMode>[]; getOperators?: null | OperatorOptions<FullOperator<string>>; getRuleClassname?: Classname; getRuleGroupClassname?: Classname; getSubQueryBuilderProps?: QueryBuilderContextProps<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }, string> & { defaultQuery?: RuleGroupTypeIC<RuleType<string, string, any, string>, string> | undefined; ... 49 more ...; context?: any; }; getValueEditorSeparator?: ReactNode; getValueEditorType?: ValueEditorType; getValues?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value?: string; }>; getValueSources?: ValueSources | ValueSourceFlexibleOptions; onAddGroup?: boolean | RuleGroupTypeIC<RuleType<string, string, any, string>, string>; onAddRule?: boolean | RuleType<string, string, any, string>; onGroupGroup?: boolean | RuleGroupTypeIC<RuleType<string, string, any, string>, string>; onGroupRule?: boolean | RuleGroupTypeIC<RuleType<string, string, any, string>, string>; onLog?: void; onMoveGroup?: boolean | RuleGroupTypeIC<RuleType<string, string, any, string>, string>; onMoveRule?: boolean | RuleGroupTypeIC<RuleType<string, string, any, string>, string>; onQueryChange?: void; onRemove?: boolean; }; getValueEditorSeparator?: ReactNode; getValueEditorType?: ValueEditorType; getValues?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value?: string; }>; getValueSources?: ValueSources | ValueSourceFlexibleOptions; onAddGroup?: boolean | RuleGroupTypeIC<RuleType<string, string, any, string>, string>; onAddRule?: boolean | RuleType<string, string, any, string>; onGroupGroup?: boolean | RuleGroupTypeIC<RuleType<string, string, any, string>, string>; onGroupRule?: boolean | RuleGroupTypeIC<RuleType<string, string, any, string>, string>; onLog?: void; onMoveGroup?: boolean | RuleGroupTypeIC<RuleType<string, string, any, string>, string>; onMoveRule?: boolean | RuleGroupTypeIC<RuleType<string, string, any, string>, string>; onQueryChange?: void; onRemove?: boolean; }

---

getValueEditorSeparator()

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

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

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/propsUsingReact.ts:643

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/propsUsingReact.ts:647

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; }): ValueSourceFullOptions

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

Parameters

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

Returns

ValueSourceFullOptions

Properties

accessibleDescriptionGenerator

accessibleDescriptionGenerator: AccessibleDescriptionGenerator

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

---

addRuleToNewGroups

addRuleToNewGroups: boolean

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

---

autoSelectField

autoSelectField: boolean

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

---

autoSelectOperator

autoSelectOperator: boolean

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

---

autoSelectValue

autoSelectValue: boolean

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

---

classNames

classNames: Classnames

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

---

combinators

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

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

---

controls

controls: Controls<F, O>

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

---

disabledPaths

disabledPaths: Path[]

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

---

enableDragAndDrop

enableDragAndDrop: boolean

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

---

fieldMap

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

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

---

fields

fields: FullOptionList<F>

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

---

independentCombinators

independentCombinators: boolean

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

---

listsAsArrays

listsAsArrays: boolean

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

---

maxLevels

maxLevels: number

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

---

parseNumbers

parseNumbers: ParseNumbersPropConfig

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

---

qbId

qbId: string

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

---

showCloneButtons

showCloneButtons: boolean

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

---

showCombinatorsBetweenRules

showCombinatorsBetweenRules: boolean

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

---

showLockButtons

showLockButtons: boolean

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

---

showNotToggle

showNotToggle: boolean

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

---

showShiftActions

showShiftActions: boolean

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

---

suppressStandardClassnames

suppressStandardClassnames: boolean

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

---

validationMap

validationMap: ValidationMap

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

---

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.