SelectControl

View as Markdown

A dropdown that fires onChange when a value is selected (e.g. to set a status).

TypeScript
export interface SelectControl<TData = any, CTX = ActionColumnContext<TData>> extends BaseControl<TData,
Extends

BaseControl<TData, CTX>

Properties

PropertyTypeDescription
onChange(value: string, context: CTX) => void | Promise<void>Handler invoked when the selected value changes. May return a Promise.
optionsValueOrFunction<AdaptableFormFieldOption[], CTX>The options to choose from - a static array or a function of the context.
Reuses so Forms and Action Columns share one vocabulary.
placeholderstringPlaceholder shown when no value is selected.
type'select'Discriminator. Set to 'select'.
valueValueOrFunction<string, CTX>The currently selected value - static or a function of the context.

Property Details

onChange

Handler invoked when the selected value changes. May return a Promise.

TypeScript
onChange: (value: string, context: CTX) => void | Promise<void>;
Property Value

(value: string, context: CTX) => void | Promise<void>

options

The options to choose from - a static array or a function of the context. Reuses so Forms and Action Columns share one vocabulary.

TypeScript
options: ValueOrFunction<AdaptableFormFieldOption[], CTX>;
Property Value

ValueOrFunction<AdaptableFormFieldOption[], CTX>

placeholder

Placeholder shown when no value is selected.

TypeScript
placeholder?: string;
Property Value

string

type

Discriminator. Set to 'select'.

TypeScript
type: 'select';
Property Value

'select'

value

The currently selected value - static or a function of the context.

TypeScript
value: ValueOrFunction<string, CTX>;
Property Value

ValueOrFunction<string, CTX>