Skip to main content

PrimeValueEditorProps

Defined in: packages/prime/src/PrimeValueEditor.tsx:23

Extends​

Methods​

handleOnChange()​

handleOnChange(value: any): void

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

Parameters​

ParameterType
valueany

Returns​

void

Inherited from​

ValueEditorProps.handleOnChange

Properties​

className?​

optional className?: string

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

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/props.ts:103

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/props.ts:98

Disables the control.

Inherited from​

ValueEditorProps.disabled


extraProps?​

optional extraProps?: Record<string, unknown>

Defined in: packages/prime/src/PrimeValueEditor.tsx:24


field​

field: string

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

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; label: string; disabled?: boolean | undefined; name: string; value: string; }> | string[] | FlexibleOption<...>[] | (string | FlexibleOpt..., operator: string, meta?: { fieldData: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | string[] | FlexibleOption<...>[] | (string | FlexibleOpt...; }) => boolean); datatype?: unknown; defaultOperator?: string; defaultValue?: any; disabled?: boolean; id?: string; inputType?: InputType | null; label: string; matchModes?: boolean | MatchMode[] | FlexibleOption<MatchMode>[]; name: string; operators?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }> | 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?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | 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[]]); }

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

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; label: string; disabled?: boolean | undefined; name: string; value: string; }> | string[] | FlexibleOption<...>[] | (string | FlexibleOpt..., operator: string, meta?: { fieldData: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | string[] | FlexibleOption<...>[] | (string | FlexibleOpt...; }) => boolean)

Field-to-field comparison filter. String: property name that must match between fields. Function: receives each candidate field, the operator, and meta.fieldData (the field declaring this comparator; may be undefined when called directly).

datatype?​

optional datatype?: unknown

Field data type. String values (a FieldDatatypeCategory or raw DB types like 'VARCHAR(50)') are normalized by getDatatypeCategory; non-strings are ignored.

defaultOperator?​

optional defaultOperator?: string

defaultValue?​

optional defaultValue?: any

disabled?​

optional disabled?: boolean

id?​

optional id?: string

inputType?​

optional inputType?: InputType | null

label​

label: string

matchModes?​

optional matchModes?: boolean | MatchMode[] | FlexibleOption<MatchMode>[]

name​

name: string

operators?​

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

placeholder?​

optional placeholder?: string

subproperties?​

optional subproperties?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | string[] | FlexibleOption<...>[] | (string | FlexibleOpt...>

Properties of items in the value.

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 | [FlexibleOption, ...FlexibleOption[]] | ((operator: string) => ValueSources | [FlexibleOption, ...FlexibleOption[]])

Inherited from​

ValueEditorProps.fieldData


inputType?​

optional inputType?: InputType | null

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

Inherited from​

ValueEditorProps.inputType


level​

level: number

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

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/props.ts:427

Inherited from​

ValueEditorProps.listsAsArrays


operator​

operator: string

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

Inherited from​

ValueEditorProps.operator


parseNumbers?​

optional parseNumbers?: ParseNumbersPropConfig

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

Inherited from​

ValueEditorProps.parseNumbers


path​

path: Path

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

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

Inherited from​

ValueEditorProps.path


rule​

rule: RuleType

Defined in: packages/core/src/types/queryBuilder.ts:12

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; label: string; disabled?: boolean | undefined; name: string; value: string; }> | string[] | FlexibleOption<...>[] | (string | FlexibleOpt..., operator: string, meta?: { fieldData: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | string[] | FlexibleOption<...>[] | (string | FlexibleOpt...; }) => boolean); datatype?: unknown; defaultOperator?: string; defaultValue?: any; disabled?: boolean; id?: string; inputType?: InputType | null; label: string; matchModes?: boolean | MatchMode[] | FlexibleOption<MatchMode>[]; name: string; operators?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }> | 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?: FlexibleOptionList<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }> | 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[]]); }, string>

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

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/props.ts:430

Inherited from​

ValueEditorProps.selectorComponent


separator?​

optional separator?: ReactNode

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

Inherited from​

ValueEditorProps.separator


skipHook?​

optional skipHook?: boolean

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

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/props.ts:111

Test ID for this component.

Inherited from​

ValueEditorProps.testID


title?​

optional title?: string

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

The title/tooltip for this control.

Inherited from​

ValueEditorProps.title


type?​

optional type?: ValueEditorType

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

Inherited from​

ValueEditorProps.type


validation?​

optional validation?: boolean | ValidationResult

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

Validation result of the parent rule/group.

Inherited from​

ValueEditorProps.validation


value?​

optional value?: any

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

Inherited from​

ValueEditorProps.value


values?​

optional values?: any[]

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

Inherited from​

ValueEditorProps.values


valueSource​

valueSource: ValueSource

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

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.