AdaptableButton

Defines a Button that appears in numerous places including Adaptable Form

TypeScript

export interface AdaptableButton<CONTEXT_TYPE extends BaseContext> extends

Extends

Identifiable

Properties

Property	Type	Description	Default
buttonStyle	`ButtonStyle\| ((button:AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) =>ButtonStyle)`	Style for Button - can be object or function that provides a `ButtonStyle` object
disabled	`(button:AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) => boolean`	Function that disables / enables the button based on its evaluation result
hidden	`(button:AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) => boolean`	Function which sets whether Button is hidden
icon	`AdaptableIcon\| ((button:AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) =>AdaptableIcon)`	Icon for Button - can be object or function that provides a `AdaptableIcon` object
iconPosition	`'start' \| 'end'`	Where the icon appears relative to the label	'start'
label	`string \| ((button:AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) => string)`	Label for Button - can be string or function that provides string
onClick	`(button:AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) => void`	Function to invoke when button is clicked
tooltip	`string \| ((button:AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) => string)`	Tooltip for Button - can be string or function that provides string

Property Details

buttonStyle

Style for Button - can be object or function that provides a ButtonStyle object

TypeScript

buttonStyle?: ButtonStyle | ((button: AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) => ButtonStyle);

Property Value

ButtonStyle| ((button:AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) =>ButtonStyle)

disabled

Function that disables / enables the button based on its evaluation result

TypeScript

disabled?: (button: AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) => boolean;

Property Value

(button:AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) => boolean

hidden

Function which sets whether Button is hidden

TypeScript

hidden?: (button: AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) => boolean;

Property Value

(button:AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) => boolean

icon

Icon for Button - can be object or function that provides a AdaptableIcon object

TypeScript

icon?: AdaptableIcon | ((button: AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) => AdaptableIcon);

Property Value

AdaptableIcon| ((button:AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) =>AdaptableIcon)

iconPosition

Where the icon appears relative to the label

TypeScript

iconPosition?: 'start' | 'end';

Default Value

'start'

Property Value

'start' | 'end'

label

Label for Button - can be string or function that provides string

TypeScript

label?: string | ((button: AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) => string);

Property Value

string | ((button:AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) => string)

onClick

Function to invoke when button is clicked

TypeScript

onClick?: (button: AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) => void;

Property Value

(button:AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) => void

Tooltip for Button - can be string or function that provides string

TypeScript

tooltip?: string | ((button: AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) => string);

Property Value

string | ((button:AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) => string)

PreviousAdaptableBooleanQuery NextAdaptableCalculatedColumnQuery