MenuBarModel

Interface representing the MenuBar class.

Properties

animationSettings MenuAnimationSettingsModel

Specifies the animation settings for the sub menu open.

Default: { duration: 400, easing: 'ease', effect: 'SlideDown' }

cssClass String

Specifies CSS classes to customize the appearance of the control.

Default: ""

enableHtmlSanitizer Boolean

Specifies whether to allow the rendering of untrusted HTML and JavaScript values withing the control. When true, any untrusted strings or scripts will be remote before rendering.

Default: true

enableRtl Boolean

Specifies whether to render the control in right to left direction.

Default: false

enableScrolling Boolean

Specifies whether to enable or disable the scrolling open for the menu. Setting has no effect on the ContextMenu control.

Default: false

enableState Boolean

Specifies whether to persist the state of the control between page loads.

No properties are saved to state at this time.

Default: false

fields FieldSettingsModel

Specifies field mappings from the dataStore to menu items.

Default: { itemId: "id", text: "text", parentId: "parentId", iconCss: "iconCss", url: "url", separator: "separator", children: "items" }

filter String

Specifies the filter selector for elements inside the target that the context menu will be opened. Setting has no effect on the Menu control.

Default: ""

hamburgerMode Boolean

Specifies whether to enable or disable the hamburger mode in menu.

Default: false

hoverDelay Number

Specifies the hover delay in milliseconds before the menu will open when the target element is hovered over.

Default: 0

items MenuItemModel

Specifies the collection of menu items.

Default: []

locale String

Specifies the culture and localization value for this control, overriding the globally defined value.

Default: en-US

orientation Orientation

Specified the orientation of the menu items.

Default: Horizontal

showItemOnClick Boolean

Specifies whether to show a sub menu or not on click.

Default: false

target String

Specifies target element which the ContextMenu should be opened or the target element to open/close the menu when clicked in Hamburger mode.

Default: ""

template String Function

Specifies the template for the menu item. Setting has no effect on the ContextMenu control.

Default: null

title String

Specifies the title for hamburger.

Default: Menu

Events

beforeClose EmitType<BeforeOpenCloseMenuEventArgs>

Event callback that is raised when before the menu is closed.

beforeItemRender EmitType<MenuEventArgs>

Triggers while rendering each menu item.

beforeOpen EmitType<BeforeOpenCloseMenuEventArgs>

Event callback that is raised when before the menu is opened.

created EmitType<CreatedEventArgs>

Event callback that is raised when the control has been created.

destroyed EmitType<Object>

Event callback that is raised when the control has been destroyed.

onClose EmitType<OpenCloseMenuEventArgs>

Event callback that is raised when the menu has closed.

onOpen EmitType<OpenCloseMenuEventArgs>

EventEvent callback that is raised when the menu has opened.

select EmitType<MenuEventArgs>

Event callback that is raised when a menu item is selected.