AlertButton
Defines a button that appears in an Alert Form
TypeScript
export interface AlertButton<AlertFormContext> extends Omit<AdaptableButton<BaseContext>, 'onClick' | 'label' | 'buttonStyle' | 'hidden' | 'disabled' | 'tooltip'Extends
Omit<AdaptableButton<BaseContext>, 'onClick' | 'label' | 'buttonStyle' | 'hidden' | 'disabled' | 'tooltip'>
Properties
| Property | Type | Description |
|---|---|---|
| ButtonStyle | ButtonStyle | Style for the Button |
| Command | AdaptableAlertCommand|AdaptableAlertCommand[] | string | string[] | ((context: AlertFormContext) => void) | Predefined Command(s) to trigger when button is clicked; implemented in commandHandlers property of Alert Options |
| Label | string | Label to show in the Button |
| Tooltip | string | Tooltip to display |
| adaptableContext | any | Custom application Context provided in AdaptableOptions.adaptableContext |
Property Details
ButtonStyle
Style for the Button
TypeScript
ButtonStyle?: ButtonStyle;Property Value
Command
Predefined Command(s) to trigger when button is clicked; implemented in commandHandlers property of Alert Options
TypeScript
Command?: AdaptableAlertCommand | AdaptableAlertCommand[] | string | string[] | ((context: AlertFormContext) => void);Property Value
AdaptableAlertCommand|AdaptableAlertCommand[] | string | string[] | ((context: AlertFormContext) => void)
Label
Label to show in the Button
TypeScript
Label: string;Property Value
string
Tooltip
Tooltip to display
TypeScript
Tooltip?: string;Property Value
string
adaptableContext
Inherited from BaseContext
Custom application Context provided in AdaptableOptions.adaptableContext
TypeScript
adaptableContext: any;Property Value
any