Skip to main content

SchemaNative<F, O>

Defined in: packages/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: packages/react-querybuilder/src/types/props.ts:660

Returns​

RuleType

Inherited from​

Schema.createRule

createRuleGroup()​

createRuleGroup(ic?: boolean): RuleGroupTypeAny

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

Parameters​

ParameterType
ic?boolean

Returns​

RuleGroupTypeAny

Inherited from​

Schema.createRuleGroup

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​

ParameterType
queryRuleGroupTypeAny
options?SetQueryStateOptions

Returns​

void

Inherited from​

Schema.dispatchQuery

getInputType()​

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

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

Parameters​

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

Returns​

InputType | null

Inherited from​

Schema.getInputType

getMatchModes()​

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

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

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: packages/react-querybuilder/src/types/props.ts:672

Parameters​

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

Returns​

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

Inherited from​

Schema.getOperators

getParameters()​

getParameters(field?: string, operator?: string, meta?: { fieldData: F; }): OptionGroup<{[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:654

Parameters​

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

Returns​

OptionGroup<{[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.getParameters

getQuery()​

getQuery(): RuleGroupTypeAny

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

Returns​

RuleGroupTypeAny

Inherited from​

Schema.getQuery

getRuleClassname()​

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

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

Parameters​

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

Returns​

Classname

Inherited from​

Schema.getRuleClassname

getRuleDefaultOperator()​

getRuleDefaultOperator(field: string): string

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

Parameters​

ParameterType
fieldstring

Returns​

string

Inherited from​

Schema.getRuleDefaultOperator

getRuleDefaultValue()​

getRuleDefaultValue(rule: RuleType): unknown

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

Parameters​

ParameterType
ruleRuleType

Returns​

unknown

Inherited from​

Schema.getRuleDefaultValue

getRuleGroupClassname()​

getRuleGroupClassname(ruleGroup: RuleGroupTypeAny): Classname

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

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; 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: 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; 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: 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; 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​

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

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

Inherited from​

Schema.getSubQueryBuilderProps

getValueEditorSeparator()​

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

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

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: packages/react-querybuilder/src/types/props.ts:673

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: packages/react-querybuilder/src/types/props.ts:677

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; }): [{ label: string; name: ValueSource; value: ValueSource; }, ...{ label: string; name: ValueSource; value: ValueSource }[]]

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

Parameters​

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

Returns​

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

Inherited from​

Schema.getValueSources

Properties​

accessibleDescriptionGenerator​

accessibleDescriptionGenerator: AccessibleDescriptionGenerator

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

Inherited from​

Schema.accessibleDescriptionGenerator

addRuleToNewGroups​

addRuleToNewGroups: boolean

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

Inherited from​

Schema.addRuleToNewGroups

autoSelectField​

autoSelectField: boolean

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

Inherited from​

Schema.autoSelectField

autoSelectOperator​

autoSelectOperator: boolean

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

Inherited from​

Schema.autoSelectOperator

autoSelectValue​

autoSelectValue: boolean

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

Inherited from​

Schema.autoSelectValue

classNames​

classNames: Classnames

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

Inherited from​

Schema.classNames

combinators​

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

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

Inherited from​

Schema.combinators

controls​

controls: Controls<F, O>

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

Inherited from​

Schema.controls

disabledPaths​

disabledPaths: Path[]

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

Inherited from​

Schema.disabledPaths

enableDragAndDrop​

enableDragAndDrop: boolean

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

Inherited from​

Schema.enableDragAndDrop

fieldMap​

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

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

Inherited from​

Schema.fieldMap

fields​

fields: FullOptionList<F>

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

Inherited from​

Schema.fields

independentCombinators​

independentCombinators: boolean

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

Inherited from​

Schema.independentCombinators

listsAsArrays​

listsAsArrays: boolean

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

Inherited from​

Schema.listsAsArrays

maxLevels​

maxLevels: number

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

Inherited from​

Schema.maxLevels

parseNumbers​

parseNumbers: ParseNumbersPropConfig

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

Inherited from​

Schema.parseNumbers

qbId​

qbId: string

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

Inherited from​

Schema.qbId

resetOnFieldChange​

resetOnFieldChange: boolean

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

Inherited from​

Schema.resetOnFieldChange

resetOnOperatorChange​

resetOnOperatorChange: boolean

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

Inherited from​

Schema.resetOnOperatorChange

showCloneButtons​

showCloneButtons: boolean

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

Inherited from​

Schema.showCloneButtons

showCombinatorsBetweenRules​

showCombinatorsBetweenRules: boolean

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

Inherited from​

Schema.showCombinatorsBetweenRules

showLockButtons​

showLockButtons: boolean

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

Inherited from​

Schema.showLockButtons

showMuteButtons​

showMuteButtons: boolean

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

Inherited from​

Schema.showMuteButtons

showNotToggle​

showNotToggle: boolean

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

Inherited from​

Schema.showNotToggle

showShiftActions​

showShiftActions: boolean

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

Inherited from​

Schema.showShiftActions

showUndoRedo​

showUndoRedo: boolean

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

Inherited from​

Schema.showUndoRedo

styles?​

optional styles?: WrapEachPropertyInStyleProp<QueryBuilderNativeStyles>

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

Inherited from​

WithOptionalStyleSheets.styles

suppressStandardClassnames​

suppressStandardClassnames: boolean

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

Inherited from​

Schema.suppressStandardClassnames

validationMap​

validationMap: ValidationMap

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

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.