WaveMaker - Widgets API Documentation
  1. Classes
  2. Menu

File

projects/components/widgets/navigation/menu/src/menu.component.doc.ts

Description

A menu displays grouped navigation actions. The drop-down menu is typically used inside the navigation header to display a list of related links on a mouse hover or click on the trigger element.

Index

Methods
Inputs

Methods

onSelect
onSelect($event: MouseEvent, widget: any, $item: any)

Callback function which will be triggered when the Menu item is selected.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered
widget any No

Instance of the button widget
$item any No

which provides selected menu item details
Returns : void

Inputs

animateitems
Type : string

This property specifies the animation of an inner items. The animation is based on the CSS classes.

Allowed Values: slide, fade, scale

slide: Inner items will have slide animation.

fade: Inner items will have fade animation.

scale: Inner items will have scale animation.
autoclose
Type : string
Default value : 'always'

This property controls the behaviour of menu when clicked.

Allowed Values: always, outsideClick, disabled

always: Closes when any of the item is selected.

outsideClick: Closes when clicked outside the menu.

disabled: Disabled auto-close.
caption
Type : string
Default value : 'Menu'

This property specifies the label of the menu.

Bindable: true
class
Type : string

Class of the widget.
dataset
Type : any
Default value : 'Menu Item 1, Menu Item 2, Menu Item 3'

Set this property to a variable to populate the list of values to display.

Bindable: true
hint
Type : string

Hint text is shown for the Menu widget on hover.

Bindable: true
iconclass
Type : string

CSS class of the icon.
itemaction
Type : string

This property specifies the item action for dynamically generated menu items.
itemchildren
Type : string

This property is to add sub menu items.

Bindable: true
itemicon
Type : string

This property specifies icon for dynamically generated menu items.

Bindable: true
itemlabel
Type : string

This property specifies label for dynamically generated menu items.

Bindable: true
itemlink
Type : string

This property specifies link for dynamically generated menu items

Bindable: true
linktarget
Type : string

This property specifies the context in which linked resources is open.

Allowed Values: _blank, _parent, _self, _top

_blank: Opens the linked document in a new window or tab.

_parent: Opens the linked document in the parent frame.

_self: Opens the linked document in the same frame as it was clicked (this is default) .

_top: Opens the linked document in the full body of the window.
menuclass
Type : string

This property specifies class of the menu.
menulayout
Type : string

This property specifies layout of menu widget.

Allowed Values: Vertical, Horizontal

Vertical: Arrange menu items vertically.

Horizontal: Arrange menu items horizontally.
menuposition
Type : string

This property specifies the position of menu item.

Allowed Values: 'down,right', 'down,left', 'up,right', 'up,left', 'inline'
name
Type : string

Name of the menu widget.
orderby
Type : string

This Property allows user for multiple selection for ordering the display of rows based on fields in ascending or descending order.
shortcutkey
Type : string

The shortcut key property specifies a shortcut key to activate/focus an element.
show
Type : boolean
Default value : true

This property will be used to show/hide the Menu widget on the web page.

Bindable: true
tabindex
Type : number
Default value : 0

This property specifies the tab order of the Menu Widget.
userrole
Type : string

This property specifies the role for dynamically generated menu items.

Bindable: true

results matching ""

    No results matching ""