Skip to main content

MaterialValueEditorProps

Defined in: packages/material/src/MaterialValueEditor.tsx:12

Extends​

Methods​

handleOnChange()​

handleOnChange(value: any): void

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

Parameters​

ParameterType
valueany

Returns​

void

Inherited from​

ValueEditorProps.handleOnChange

Properties​

className?​

optional className: string

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

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​

ValueEditorProps.className

context?​

optional context: any

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

Container for custom props that are passed to all components.

Inherited from​

ValueEditorProps.context

disabled?​

optional disabled: boolean

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

Disables the control.

Inherited from​

ValueEditorProps.disabled

extraProps?​

optional extraProps: Record<string, unknown>

Defined in: packages/material/src/MaterialValueEditor.tsx:14

field​

field: string

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

Inherited from​

ValueEditorProps.field

fieldData​

fieldData: {[key: string]: unknown; className?: Classname; comparator?: string | (f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; ... 9 more ...; className?: Clas..., operator: string) => boolean; defaultOperator?: string; defaultValue?: any; disabled?: boolean; id?: string; inputType?: null | InputType; label: string; name: string; operators?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value?: string; }>; placeholder?: string; validator?: RuleValidator; value: string; valueEditorType?: ValueEditorType | (operator: string) => ValueEditorType; values?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value?: string; }>; valueSources?: ValueSources | (operator: string) => ValueSources; }

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

The entire FullField object.

Index Signature​

[key: string]: unknown

className?​

optional className: Classname

comparator?​

optional comparator: string | (f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; ... 9 more ...; className?: Clas..., operator: string) => boolean

defaultOperator?​

optional defaultOperator: string

defaultValue?​

optional defaultValue: any

disabled?​

optional disabled: boolean

id?​

optional id: string

inputType?​

optional inputType: null | InputType

label​

label: string

name​

name: string

operators?​

optional operators: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value?: string; }>

placeholder?​

optional placeholder: string

validator?​

optional validator: RuleValidator

value​

value: string

valueEditorType?​

optional valueEditorType: ValueEditorType | (operator: string) => ValueEditorType

values?​

optional values: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value?: string; }>

valueSources?​

optional valueSources: ValueSources | (operator: string) => ValueSources

Inherited from​

ValueEditorProps.fieldData

inputType?​

optional inputType: null | InputType

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

Inherited from​

ValueEditorProps.inputType

level​

level: number

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

The level of the current group. Always equal to path.length.

Inherited from​

ValueEditorProps.level

listsAsArrays?​

optional listsAsArrays: boolean

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

Inherited from​

ValueEditorProps.listsAsArrays

muiComponents?​

optional muiComponents: RQBMaterialComponents

Defined in: packages/material/src/MaterialValueEditor.tsx:13

operator​

operator: string

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

Inherited from​

ValueEditorProps.operator

parseNumbers?​

optional parseNumbers: ParseNumbersPropConfig

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

Inherited from​

ValueEditorProps.parseNumbers

path​

path: Path

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

Path to this subcomponent's rule/group within the query.

Inherited from​

ValueEditorProps.path

rule​

rule: RuleType

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

Inherited from​

ValueEditorProps.rule

schema​

schema: Schema<{[key: string]: unknown; className?: Classname; comparator?: string | (f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; ... 9 more ...; className?: Clas..., operator: string) => boolean; defaultOperator?: string; defaultValue?: any; disabled?: boolean; id?: string; inputType?: null | InputType; label: string; name: string; operators?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value?: string; }>; placeholder?: string; validator?: RuleValidator; value: string; valueEditorType?: ValueEditorType | (operator: string) => ValueEditorType; values?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value?: string; }>; valueSources?: ValueSources | (operator: string) => ValueSources; }, string>

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

All subcomponents receive the configuration schema as a prop.

Inherited from​

ValueEditorProps.schema

selectorComponent?​

optional selectorComponent: ComponentType<ValueSelectorProps<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>>

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

Inherited from​

ValueEditorProps.selectorComponent

separator?​

optional separator: ReactNode

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

Inherited from​

ValueEditorProps.separator

skipHook?​

optional skipHook: boolean

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

Only pass true if the useValueEditor hook has already run in a parent/ancestor component. See usage in the compatibility packages.

Inherited from​

ValueEditorProps.skipHook

testID?​

optional testID: string

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

Test ID for this component.

Inherited from​

ValueEditorProps.testID

title?​

optional title: string

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

The title/tooltip for this control.

Inherited from​

ValueEditorProps.title

type?​

optional type: ValueEditorType

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

Inherited from​

ValueEditorProps.type

validation?​

optional validation: boolean | ValidationResult

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

Validation result of the parent rule/group.

Inherited from​

ValueEditorProps.validation

value?​

optional value: any

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

Inherited from​

ValueEditorProps.value

values?​

optional values: any[]

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

Inherited from​

ValueEditorProps.values

valueSource​

valueSource: ValueSource

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

Inherited from​

ValueEditorProps.valueSource

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.