Skip to main content

ExpressionUIContextValue

Defined in: expr/src/ui/ExpressionUIContext.ts:20

Value carried by ExpressionUIContext.

Properties​

allowFunctionsOnLHS​

allowFunctionsOnLHS: AllowFunctionsOnLHS

Defined in: expr/src/ui/ExpressionUIContext.ts:29

Whether the left-hand side may wrap its field in a function. false (default) hides the wrapper selector entirely; a predicate gates it per field/operator.


inheritedFieldSelector​

inheritedFieldSelector: ComponentType<FieldSelectorProps<{[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[]]); }>> | null

Defined in: expr/src/ui/ExpressionUIContext.ts:34

Field selector inherited from an outer (compat) provider, captured before QueryBuilderExpressions overrides it. null = none (use the default).


inheritedValueEditor​

inheritedValueEditor: 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>> | null

Defined in: expr/src/ui/ExpressionUIContext.ts:39

Value editor inherited from an outer (compat) provider, captured before QueryBuilderExpressions overrides it. null = none (use the default).


inheritedValueSourceSelector​

inheritedValueSourceSelector: ComponentType<ValueSourceSelectorProps> | null

Defined in: expr/src/ui/ExpressionUIContext.ts:44

Value-source selector inherited from an outer (compat) provider, captured before QueryBuilderExpressions overrides it. null = none (use the default).


meta​

meta: ExpressionFunctionMetaRegistry

Defined in: expr/src/ui/ExpressionUIContext.ts:22

Function metadata (label/arity) available to the expression editors.


translations​

translations: TranslationsFullExpr

Defined in: expr/src/ui/ExpressionUIContext.ts:24

Titles and labels for expression UI elements.


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.