TremorValueSelectorProps

Defined in: packages/tremor/src/TremorValueSelector.tsx:11

Extends

• VersatileSelectorProps.Omit<SelectProps & MultiSelectProps, "children" | "value">

Methods

handleOnChange()

handleOnChange(value: any): void

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

Parameters

Parameter	Type
value	any

Returns

void

Inherited from

VersatileSelectorProps.handleOnChange

Properties

className?

optional className?: string

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

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

TremorActionProps.className

---

context?

optional context?: any

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

Container for custom props that are passed to all components.

Inherited from

TremorActionProps.context

---

defaultValue?

optional defaultValue?: string & string[]

Defined in: node_modules/@tremor/react/dist/index.d.ts:374

Inherited from

Omit.defaultValue

---

disabled?

optional disabled?: boolean

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

Disables the control.

Inherited from

TremorActionProps.disabled

---

enableClear?

optional enableClear?: boolean

Defined in: node_modules/@tremor/react/dist/index.d.ts:379

Inherited from

Omit.enableClear

---

error?

optional error?: boolean

Defined in: node_modules/@tremor/react/dist/index.d.ts:381

Inherited from

Omit.error

---

errorMessage?

optional errorMessage?: string

Defined in: node_modules/@tremor/react/dist/index.d.ts:382

Inherited from

Omit.errorMessage

---

field?

optional field?: string

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

Inherited from

VersatileSelectorProps.field

---

fieldData?

optional 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 | ValueSourceFlexibleOptions | ((operator: string) => ValueSources | ValueSourceFlexibleOptions); }, 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 | ValueSourceFlexibleOptions | ((operator: string) => ValueSources | ValueSourceFlexibleOptions) | undefined; }>; validator?: RuleValidator; value: string; valueEditorType?: ValueEditorType | ((operator: string) => ValueEditorType); values?: FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>; valueSources?: ValueSources | ValueSourceFlexibleOptions | ((operator: string) => ValueSources | ValueSourceFlexibleOptions); }

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

Index Signature

[key: string]: unknown

className?

optional className?: Classname

comparator?

optional 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 | ValueSourceFlexibleOptions | ((operator: string) => ValueSources | ValueSourceFlexibleOptions); }, operator: string) => boolean)

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?: string[] | FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }> | FlexibleOption<string>[] | string | FlexibleOption<string>[]

placeholder?

optional placeholder?: string

subproperties?

optional 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 | ValueSourceFlexibleOptions | ((operator: string) => ValueSources | ValueSourceFlexibleOptions) | undefined; }>

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 | ValueSourceFlexibleOptions | ((operator: string) => ValueSources | ValueSourceFlexibleOptions)

Inherited from

VersatileSelectorProps.fieldData

---

icon?

optional icon?: JSXElementConstructor<any> & (JSXElementConstructor<any> | ElementType<any, keyof IntrinsicElements>)

Defined in: node_modules/@tremor/react/dist/index.d.ts:378

Inherited from

Omit.icon

---

level

level: number

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

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

Inherited from

TremorActionProps.level

---

listsAsArrays?

optional listsAsArrays?: boolean

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

Inherited from

VersatileSelectorProps.listsAsArrays

---

multiple?

optional multiple?: boolean

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

Inherited from

VersatileSelectorProps.multiple

---

name?

optional name?: string

Defined in: node_modules/@tremor/react/dist/index.d.ts:373

Inherited from

Omit.name

---

onValueChange?

optional onValueChange?: (value: string) => void & (value: string[]) => void

Defined in: node_modules/@tremor/react/dist/index.d.ts:375

Inherited from

Omit.onValueChange

---

operator?

optional operator?: string

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

Inherited from

VersatileSelectorProps.operator

---

options

options: (OptionGroup<{ [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }>[] | { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; }[]) & (OptionGroup<...>[] | ... 1 more ... | undefined) & ((FullOperator<string>[] | OptionGroup<FullOperator<string>>[]) & (FullCombinator[] | OptionGroup<FullCombinator>[])) | undefined

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

Inherited from

VersatileSelectorProps.options

---

path

path: Path

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

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

Inherited from

TremorActionProps.path

---

placeholder?

optional placeholder?: string

Defined in: node_modules/@tremor/react/dist/index.d.ts:376

Inherited from

Omit.placeholder

---

placeholderSearch?

optional placeholderSearch?: string

Defined in: node_modules/@tremor/react/dist/index.d.ts:309

Inherited from

Omit.placeholderSearch

---

required?

optional required?: boolean

Defined in: node_modules/@tremor/react/dist/index.d.ts:380

Inherited from

Omit.required

---

rule?

optional rule?: RuleType<string, string, any, string, Record<string, any>>

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

Inherited from

TremorValueEditorProps.rule

---

ruleGroup?

optional ruleGroup?: RuleGroupTypeAny

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

Inherited from

VersatileSelectorProps.ruleGroup

---

rules?

optional rules?: RuleOrGroupArray

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

Inherited from

VersatileSelectorProps.rules

---

schema

schema: Schema<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }, string> & 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?: 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; 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 | ValueSourceFlexibleOptions | ((operator: string) => ValueSources | ValueSourceFlexibleOptions); }, string>

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

All subcomponents receive the configuration schema as a prop.

Inherited from

VersatileSelectorProps.schema

---

testID?

optional testID?: string

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

Test ID for this component.

Inherited from

TremorActionProps.testID

---

title?

optional title?: string

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

The title/tooltip for this control.

Inherited from

TremorActionProps.title

---

validation?

optional validation?: boolean | ValidationResult

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

Validation result of the parent rule/group.

Inherited from

TremorActionProps.validation

---

value?

optional value?: any

Defined in: packages/tremor/src/TremorValueSelector.tsx:14

Overrides

VersatileSelectorProps.value

---

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.