Skip to main content

SchemaNative<F, O>

Defined in: native/src/types.ts:38

Extends​

  • Schema<F, O>.WithOptionalStyleSheets

Type Parameters​

Type Parameter
F extends FullField
O extends string

Methods​

createRule()​

createRule(): RuleType

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

Returns​

RuleType

Inherited from​

Schema.createRule

createRuleGroup()​

createRuleGroup(ic?: boolean): RuleGroupTypeAny

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

Parameters​

ParameterType
ic?boolean

Returns​

RuleGroupTypeAny

Inherited from​

Schema.createRuleGroup

dispatchQuery()​

dispatchQuery(query: RuleGroupTypeAny): void

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

Parameters​

ParameterType
queryRuleGroupTypeAny

Returns​

void

Inherited from​

Schema.dispatchQuery

getInputType()​

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

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

Parameters​

ParameterType
fieldstring
operatorstring
meta{ fieldData: F; }
meta.fieldDataF

Returns​

null | InputType

Inherited from​

Schema.getInputType

getMatchModes()​

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

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

Parameters​

ParameterType
fieldstring
misc{ fieldData: F; }
misc.fieldDataF

Returns​

MatchModeOptions

Inherited from​

Schema.getMatchModes

getOperators()​

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

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

Parameters​

ParameterType
fieldstring
meta{ fieldData: F; }
meta.fieldDataF

Returns​

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

Inherited from​

Schema.getOperators

getQuery()​

getQuery(): RuleGroupTypeAny

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

Returns​

RuleGroupTypeAny

Inherited from​

Schema.getQuery

getRuleClassname()​

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

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

Parameters​

ParameterType
ruleRuleType
misc{ fieldData: F; }
misc.fieldDataF

Returns​

Classname

Inherited from​

Schema.getRuleClassname

getRuleGroupClassname()​

getRuleGroupClassname(ruleGroup: RuleGroupTypeAny): Classname

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

Parameters​

ParameterType
ruleGroupRuleGroupTypeAny

Returns​

Classname

Inherited from​

Schema.getRuleGroupClassname

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: OptionGroup<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>[] | {[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: OptionGroup<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>[] | {[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: react-querybuilder/src/types/propsUsingReact.ts:649

Parameters​

ParameterType
fieldGetOptionIdentifierType<F>
misc{ fieldData: F; }
misc.fieldDataF

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: OptionGroup<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>[] | {[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: OptionGroup<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>[] | {[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; }

Inherited from​

Schema.getSubQueryBuilderProps

getValueEditorSeparator()​

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

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

Parameters​

ParameterType
fieldstring
operatorstring
meta{ fieldData: F; }
meta.fieldDataF

Returns​

ReactNode

Inherited from​

Schema.getValueEditorSeparator

getValueEditorType()​

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

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

Parameters​

ParameterType
fieldstring
operatorstring
meta{ fieldData: F; }
meta.fieldDataF

Returns​

ValueEditorType

Inherited from​

Schema.getValueEditorType

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: react-querybuilder/src/types/propsUsingReact.ts:647

Parameters​

ParameterType
fieldstring
operatorstring
meta{ fieldData: F; }
meta.fieldDataF

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; }>>[]

Inherited from​

Schema.getValues

getValueSources()​

getValueSources(field: string, operator: string, meta: { fieldData: F; }): ValueSourceFullOptions

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

Parameters​

ParameterType
fieldstring
operatorstring
meta{ fieldData: F; }
meta.fieldDataF

Returns​

ValueSourceFullOptions

Inherited from​

Schema.getValueSources

Properties​

accessibleDescriptionGenerator​

accessibleDescriptionGenerator: AccessibleDescriptionGenerator

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

Inherited from​

Schema.accessibleDescriptionGenerator

addRuleToNewGroups​

addRuleToNewGroups: boolean

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

Inherited from​

Schema.addRuleToNewGroups

autoSelectField​

autoSelectField: boolean

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

Inherited from​

Schema.autoSelectField

autoSelectOperator​

autoSelectOperator: boolean

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

Inherited from​

Schema.autoSelectOperator

autoSelectValue​

autoSelectValue: boolean

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

Inherited from​

Schema.autoSelectValue

classNames​

classNames: Classnames

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

Inherited from​

Schema.classNames

combinators​

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

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

Inherited from​

Schema.combinators

controls​

controls: Controls<F, O>

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

Inherited from​

Schema.controls

disabledPaths​

disabledPaths: Path[]

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

Inherited from​

Schema.disabledPaths

enableDragAndDrop​

enableDragAndDrop: boolean

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

Inherited from​

Schema.enableDragAndDrop

fieldMap​

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

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

Inherited from​

Schema.fieldMap

fields​

fields: FullOptionList<F>

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

Inherited from​

Schema.fields

independentCombinators​

independentCombinators: boolean

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

Inherited from​

Schema.independentCombinators

listsAsArrays​

listsAsArrays: boolean

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

Inherited from​

Schema.listsAsArrays

maxLevels​

maxLevels: number

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

Inherited from​

Schema.maxLevels

parseNumbers​

parseNumbers: ParseNumbersPropConfig

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

Inherited from​

Schema.parseNumbers

qbId​

qbId: string

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

Inherited from​

Schema.qbId

showCloneButtons​

showCloneButtons: boolean

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

Inherited from​

Schema.showCloneButtons

showCombinatorsBetweenRules​

showCombinatorsBetweenRules: boolean

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

Inherited from​

Schema.showCombinatorsBetweenRules

showLockButtons​

showLockButtons: boolean

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

Inherited from​

Schema.showLockButtons

showNotToggle​

showNotToggle: boolean

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

Inherited from​

Schema.showNotToggle

showShiftActions​

showShiftActions: boolean

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

Inherited from​

Schema.showShiftActions

styles?​

optional styles: WrapEachPropertyInStyleProp<QueryBuilderNativeStyles>

Defined in: native/src/types.ts:32

Inherited from​

WithOptionalStyleSheets.styles

suppressStandardClassnames​

suppressStandardClassnames: boolean

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

Inherited from​

Schema.suppressStandardClassnames

validationMap​

validationMap: ValidationMap

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

Inherited from​

Schema.validationMap

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.