BaseControl
Properties shared by every .
export interface BaseControl<TData = any,Properties
| Property | Type | Description | Default |
|---|---|---|---|
| disabled | ValueOrFunction<boolean, CTX> | Whether the Control is disabled - static boolean or a function of the context | |
| hidden | ValueOrFunction<boolean, CTX> | Whether the Control is hidden - static boolean or a function of the context | |
| icon | ValueOrFunction<AdaptableIcon, CTX> | Icon for the Control - static AdaptableIcon or a function of the context | |
| iconPosition | 'start' | 'end' | Where the icon appears relative to the label | 'start' |
| id | string | Optional stable identifier for the Control (useful for testing / targeting) | |
| label | ValueOrFunction<string, CTX> | Label for the Control - static string or a function of the context | |
| style | ValueOrFunction<ButtonStyle, CTX> | Style for the Control - static ButtonStyle or a function of the context | |
| tooltip | ValueOrFunction<string, CTX> | Tooltip for the Control - static string or a function of the context |
Property Details
disabled
Whether the Control is disabled - static boolean or a function of the context
disabled?: ValueOrFunction<boolean, CTX>;Property Value
ValueOrFunction<boolean, CTX>
hidden
Whether the Control is hidden - static boolean or a function of the context
hidden?: ValueOrFunction<boolean, CTX>;Property Value
ValueOrFunction<boolean, CTX>
icon
Icon for the Control - static AdaptableIcon or a function of the context
icon?: ValueOrFunction<AdaptableIcon, CTX>;Property Value
ValueOrFunction<AdaptableIcon, CTX>
iconPosition
Where the icon appears relative to the label
iconPosition?: 'start' | 'end';Default Value
'start'
Property Value
'start' | 'end'
id
Optional stable identifier for the Control (useful for testing / targeting)
id?: string;Property Value
string
label
Label for the Control - static string or a function of the context
label?: ValueOrFunction<string, CTX>;Property Value
ValueOrFunction<string, CTX>
style
Style for the Control - static ButtonStyle or a function of the context
style?: ValueOrFunction<ButtonStyle, CTX>;Property Value
ValueOrFunction<ButtonStyle, CTX>
tooltip
Tooltip for the Control - static string or a function of the context
tooltip?: ValueOrFunction<string, CTX>;Property Value
ValueOrFunction<string, CTX>