MatchModeEditorProps
Defined in: packages/react-querybuilder/src/types/props.ts:173
Props for matchModeEditor components.
Extends
BaseSelectorProps<FullOption>.CommonRuleSubComponentProps
Methods
handleOnChange()
handleOnChange(
value:any):void
Defined in: packages/react-querybuilder/src/types/props.ts:123
Parameters
| Parameter | Type |
|---|---|
value | any |
Returns
void
Inherited from
BaseSelectorProps.handleOnChange
Properties
className?
optionalclassName?:string
Defined in: packages/react-querybuilder/src/types/props.ts:76
CSS classNames to be applied.
This is string and not Classname because the Rule
and RuleGroup components run clsx() to produce the className
that gets passed to each subcomponent.
Inherited from
BaseSelectorProps.className
classNames
classNames: {
matchMode:string;matchThreshold:string; }
Defined in: packages/react-querybuilder/src/types/props.ts:179
matchMode
matchMode:
string
matchThreshold
matchThreshold:
string
context?
optionalcontext?:any
Defined in: packages/react-querybuilder/src/types/props.ts:97
Container for custom props that are passed to all components.
Inherited from
BaseSelectorProps.context
disabled?
optionaldisabled?:boolean
Defined in: packages/react-querybuilder/src/types/props.ts:92
Disables the control.
Inherited from
BaseSelectorProps.disabled
field
field:
string
Defined in: packages/react-querybuilder/src/types/props.ts:181
fieldData
fieldData: {[
key:string]:unknown;className?:Classname;comparator?:string| ((f: {[key:string]:unknown;className?:Classname;comparator?: string | ((f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (string...;defaultOperator?:string;defaultValue?:any;disabled?:boolean;id?:string;inputType?:InputType|null;label:string;matchModes?:boolean|MatchMode[] |FlexibleOption<MatchMode>[];name:string;operators?:string[] |FlexibleOptionList<{[key:string]:unknown;disabled?:boolean;label:string;name:string;value:string; }> |FlexibleOption<string>[] | string | FlexibleOption<string>[];placeholder?:string;subproperties?:FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (string | FlexibleOpt...>;validator?:RuleValidator;value:string;valueEditorType?:ValueEditorType| ((operator:string) =>ValueEditorType);values?:FlexibleOptionList<{[key:string]:unknown;disabled?:boolean;label:string;name:string;value:string; }>;valueSources?:ValueSources| [FlexibleOption,...FlexibleOption[]] | ((operator:string) =>ValueSources| [FlexibleOption,...FlexibleOption[]]); },operator:string) =>boolean);defaultOperator?:string;defaultValue?:any;disabled?:boolean;id?:string;inputType?:InputType|null;label:string;matchModes?:boolean|MatchMode[] |FlexibleOption<MatchMode>[];name:string;operators?:string[] |FlexibleOptionList<{[key:string]:unknown;disabled?:boolean;label:string;name:string;value:string; }> |FlexibleOption<string>[] | string | FlexibleOption<string>[];placeholder?:string;subproperties?:FlexibleOptionList<{[key:string]:unknown;className?: Classname | undefined;comparator?:string| ((f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (string | FlexibleOpt...,operator:string) =>boolean);defaultOperator?:string;defaultValue?:any;disabled?:boolean;id?:string;inputType?: InputType | null | undefined;label:string;matchModes?:boolean|MatchMode[] |FlexibleOption<MatchMode>[];name:string;operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<string>[] | (string | FlexibleOption<...>)[] | undefined;placeholder?:string;subproperties?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (s...;validator?:RuleValidator;value:string;valueEditorType?: ValueEditorType | ((operator: string) => ValueEditorType) | undefined;values?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | undefined;valueSources?:ValueSources| [FlexibleOption,...FlexibleOption[]] | ((operator:string) =>ValueSources| [FlexibleOption,...FlexibleOption[]]); }>;validator?:RuleValidator;value:string;valueEditorType?:ValueEditorType| ((operator:string) =>ValueEditorType);values?:FlexibleOptionList<{[key:string]:unknown;disabled?:boolean;label:string;name:string;value:string; }>;valueSources?:ValueSources| [FlexibleOption,...FlexibleOption[]] | ((operator:string) =>ValueSources| [FlexibleOption,...FlexibleOption[]]); }
Defined in: packages/react-querybuilder/src/types/props.ts:182
Index Signature
[key: string]: unknown
className?
optionalclassName?:Classname
comparator?
optionalcomparator?:string| ((f: {[key:string]:unknown;className?:Classname;comparator?: string | ((f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (string...;defaultOperator?:string;defaultValue?:any;disabled?:boolean;id?:string;inputType?:InputType|null;label:string;matchModes?:boolean|MatchMode[] |FlexibleOption<MatchMode>[];name:string;operators?:string[] |FlexibleOptionList<{[key:string]:unknown;disabled?:boolean;label:string;name:string;value:string; }> |FlexibleOption<string>[] | string | FlexibleOption<string>[];placeholder?:string;subproperties?:FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (string | FlexibleOpt...>;validator?:RuleValidator;value:string;valueEditorType?:ValueEditorType| ((operator:string) =>ValueEditorType);values?:FlexibleOptionList<{[key:string]:unknown;disabled?:boolean;label:string;name:string;value:string; }>;valueSources?:ValueSources| [FlexibleOption,...FlexibleOption[]] | ((operator:string) =>ValueSources| [FlexibleOption,...FlexibleOption[]]); },operator:string) =>boolean)
defaultOperator?
optionaldefaultOperator?:string
defaultValue?
optionaldefaultValue?:any
disabled?
optionaldisabled?:boolean
id?
optionalid?:string
inputType?
optionalinputType?:InputType|null
label
label:
string
matchModes?
optionalmatchModes?:boolean|MatchMode[] |FlexibleOption<MatchMode>[]
name
name:
string
operators?
optionaloperators?:string[] |FlexibleOptionList<{[key:string]:unknown;disabled?:boolean;label:string;name:string;value:string; }> |FlexibleOption<string>[] | string | FlexibleOption<string>[]
placeholder?
optionalplaceholder?:string
subproperties?
optionalsubproperties?:FlexibleOptionList<{[key:string]:unknown;className?: Classname | undefined;comparator?:string| ((f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (string | FlexibleOpt...,operator:string) =>boolean);defaultOperator?:string;defaultValue?:any;disabled?:boolean;id?:string;inputType?: InputType | null | undefined;label:string;matchModes?:boolean|MatchMode[] |FlexibleOption<MatchMode>[];name:string;operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<string>[] | (string | FlexibleOption<...>)[] | undefined;placeholder?:string;subproperties?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (s...;validator?:RuleValidator;value:string;valueEditorType?: ValueEditorType | ((operator: string) => ValueEditorType) | undefined;values?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | undefined;valueSources?:ValueSources| [FlexibleOption,...FlexibleOption[]] | ((operator:string) =>ValueSources| [FlexibleOption,...FlexibleOption[]]); }>
Properties of items in the value.
validator?
optionalvalidator?:RuleValidator
value
value:
string
valueEditorType?
optionalvalueEditorType?:ValueEditorType| ((operator:string) =>ValueEditorType)
values?
optionalvalues?:FlexibleOptionList<{[key:string]:unknown;disabled?:boolean;label:string;name:string;value:string; }>
valueSources?
optionalvalueSources?:ValueSources| [FlexibleOption,...FlexibleOption[]] | ((operator:string) =>ValueSources| [FlexibleOption,...FlexibleOption[]])
level
level:
number
Defined in: packages/react-querybuilder/src/types/props.ts:84
The level of the current group. Always equal to path.length.
Inherited from
BaseSelectorProps.level
match
match:
MatchConfig
Defined in: packages/react-querybuilder/src/types/props.ts:175
numericEditorComponent?
optionalnumericEditorComponent?:ComponentType<ValueEditorProps<{[key:string]:unknown;className?: Classname | undefined;comparator?:string| ((f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (string | FlexibleOpt...,operator:string) =>boolean);defaultOperator?:string;defaultValue?:any;disabled?:boolean;id?:string;inputType?: InputType | null | undefined;label:string;matchModes?:boolean|MatchMode[] |FlexibleOption<MatchMode>[];name:string;operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<string>[] | (string | FlexibleOption<...>)[] | undefined;placeholder?:string;subproperties?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: string[] | FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | FlexibleOption<...>[] | (s...;validator?:RuleValidator;value:string;valueEditorType?: ValueEditorType | ((operator: string) => ValueEditorType) | undefined;values?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | undefined;valueSources?:ValueSources| [FlexibleOption,...FlexibleOption[]] | ((operator:string) =>ValueSources| [FlexibleOption,...FlexibleOption[]]); },string>>
Defined in: packages/react-querybuilder/src/types/props.ts:177
options
options: {[
key:string]:unknown;disabled?:boolean;label:string;name:MatchMode;value:MatchMode; }[] |OptionGroup<{[key:string]:unknown;disabled?:boolean;label:string;name:MatchMode;value:MatchMode; }>[]
Defined in: packages/react-querybuilder/src/types/props.ts:180
Overrides
BaseSelectorProps.options
path
path:
Path
Defined in: packages/react-querybuilder/src/types/props.ts:80
Path to this subcomponent's rule/group within the query.
Inherited from
BaseSelectorProps.path
rule
rule:
RuleType
Defined in: packages/core/src/types/queryBuilder.ts:12
Inherited from
CommonRuleSubComponentProps.rule
schema
schema:
Schema<{[key:string]:unknown;disabled?:boolean;label:string;name:string;value:string; },string>
Defined in: packages/react-querybuilder/src/types/props.ts:109
All subcomponents receive the configuration schema as a prop.
Inherited from
BaseSelectorProps.schema
selectorComponent?
optionalselectorComponent?:ComponentType<ValueSelectorProps<{[key:string]:unknown;disabled?:boolean;label:string;name:string;value:string; }>>
Defined in: packages/react-querybuilder/src/types/props.ts:176
testID?
optionaltestID?:string
Defined in: packages/react-querybuilder/src/types/props.ts:105
Test ID for this component.
Inherited from
BaseSelectorProps.testID
thresholdPlaceholder?
optionalthresholdPlaceholder?:string
Defined in: packages/react-querybuilder/src/types/props.ts:178
title?
optionaltitle?:string
Defined in: packages/react-querybuilder/src/types/props.ts:88
The title/tooltip for this control.
Inherited from
BaseSelectorProps.title
validation?
optionalvalidation?:boolean|ValidationResult
Defined in: packages/react-querybuilder/src/types/props.ts:101
Validation result of the parent rule/group.
Inherited from
BaseSelectorProps.validation
value?
optionalvalue?:string
Defined in: packages/react-querybuilder/src/types/props.ts:121
Inherited from
BaseSelectorProps.value
API documentation is generated from the latest commit on the main branch. It may be somewhat inconsistent with official releases of React Query Builder.