Skip to main content

UseValueEditor

Defined in: packages/react-querybuilder/src/components/ValueEditor.tsx:220

Properties

bigIntValueHandler()

bigIntValueHandler: (val: unknown) => void

Defined in: packages/react-querybuilder/src/components/ValueEditor.tsx:240

An update handler for bigint editors, e.g. when inputType is "bigint" and parseNumbersMethod is truthy.

Parameters

ParameterType
valunknown

Returns

void


inputTypeCoerced

inputTypeCoerced: InputType

Defined in: packages/react-querybuilder/src/components/ValueEditor.tsx:255

Coerced inputType based on inputType and operator.


multiValueHandler()

multiValueHandler: (val: unknown, idx: number) => void

Defined in: packages/react-querybuilder/src/components/ValueEditor.tsx:235

An update handler for a series of value editors, e.g. when operator is "between". Calling this function will update a single element of the value array and leave the rest of the array as is.

Parameters

ParameterTypeDescription
valunknownThe new value for the editor
idxnumberThe index of the editor (and the array element to update)

Returns

void


parseNumberMethod

parseNumberMethod: ParseNumberMethod

Defined in: packages/react-querybuilder/src/components/ValueEditor.tsx:247

Evaluated parseNumber method based on parseNumbers prop. This property ends up being the same as the parseNumbers prop minus the "-limited" suffix, unless the "-limited" suffix is present and the inputType is not "number", in which case it's set to false.


valueAsArray

valueAsArray: any[]

Defined in: packages/react-querybuilder/src/components/ValueEditor.tsx:226

Array of values for when the main value represents a list, e.g. when operator is "between" or "in".


valueListItemClassName

valueListItemClassName: string

Defined in: packages/react-querybuilder/src/components/ValueEditor.tsx:251

Class for items in a value editor series (e.g. "between" value editors).


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.