AdapTable Types Reference

UserMenuItem

Menu Item which is added to Column or Context Menu - can contain sub items

TypeScript
export interface UserMenuItem<CONTEXT_TYPE extends

Properties

PropertyDescription
disabledFunction evaluating whether Menu Item is enabled
hiddenFunction evaluating whether Menu Item is visible
iconOptional icon to display
labelText to appear in the Menu Item
onClickFunction invoked when the Menu Item is clicked
subMenuItemsArray of Menu Items, enabling limitless levels of menus

Property Details

disabled

Function evaluating whether Menu Item is enabled

TypeScript
disabled?: (menuContext: CONTEXT_TYPE) => boolean;
Property Value

(menuContext: CONTEXT_TYPE) => boolean

hidden

Function evaluating whether Menu Item is visible

TypeScript
hidden?: (menuContext: CONTEXT_TYPE) => boolean;
Property Value

(menuContext: CONTEXT_TYPE) => boolean

icon

Optional icon to display

TypeScript
icon?: ((menuContext: CONTEXT_TYPE) => AdaptableIcon) | AdaptableIcon;
Property Value

((menuContext: CONTEXT_TYPE) =>AdaptableIcon) |AdaptableIcon

label

Text to appear in the Menu Item

TypeScript
label: string | ((context: CONTEXT_TYPE) => string);
Property Value

string | ((context: CONTEXT_TYPE) => string)

onClick

Function invoked when the Menu Item is clicked

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

(menuContext: CONTEXT_TYPE) => void

subMenuItems

Array of Menu Items, enabling limitless levels of menus

TypeScript
subMenuItems?: UserMenuItem<CONTEXT_TYPE>[];
Property Value

UserMenuItem<CONTEXT_TYPE>[]

PreviousUserInterfaceStateNextVueFrameworkComponent