AdaptableMenuItem

Menu item used by Adaptable in 3 places: Module Menu (at left of Dashboard Header), Column Header Menu and Context Menu

TypeScript
export interface AdaptableMenuItem

Properties

PropertyDescription
iconIcon to display in Menu Item
isVisibleWhether menu item is visible
labelName that appears in the menu
moduleAdaptable Module associated with (shipped) menu item.
onClickFunction to invoice when (custom) menu item is clicked
reduxActionAdaptable Redux Action to invoke when (shipped) menu item is clicked
subItemsSub Menu Items to display

Property Details

icon

Icon to display in Menu Item

TypeScript
icon?: string;
Property Value

string

isVisible

Whether menu item is visible

TypeScript
isVisible: boolean;
Property Value

boolean

label

Name that appears in the menu

TypeScript
label: string;
Property Value

string

module

Adaptable Module associated with (shipped) menu item.

TypeScript
module?: AdaptableModule | 'General';
Property Value

AdaptableModule | 'General'

onClick

Function to invoice when (custom) menu item is clicked

TypeScript
onClick?: () => void;
Property Value

() => void

reduxAction

Adaptable Redux Action to invoke when (shipped) menu item is clicked

TypeScript
reduxAction?: Redux.Action;
Property Value

Redux.Action

subItems

Sub Menu Items to display

TypeScript
subItems?: AdaptableMenuItem[];
Property Value

AdaptableMenuItem[]