WaveMaker - Widgets API Documentation
  1. Classes
  2. Nav

File

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

Description

The wmNav component defines the Nav widget.

Index

Methods
Inputs

Methods

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

Callback function which will be triggered when nav item is selected.

Parameters :
Name Type Optional Description
$event Event No

DOM event on which call back is triggered.
widget any No

Instance of the nav.
$item any No

Nav item object.
Returns : void

Inputs

autoclose
Type : string
Default value : 'outsideClick'

This property controls how the nav items are displayed within the Nav

Allowed Values: outsideClick, always, disabled

outsideClick: Close the menu when clicked outside of the menu

always: When a menu item is selected or on click outside menu

disabled: Close only when the menu is clicked.
class
Type : string

Class of the widget.
dataset
Type : Array<any>

Set this property to a data source to construct a nav.

Bindable: true
horizontalalign
Type : string

This property specifies how the elements should be aligned horizontally.

Allowed Values: left, center, right

left: Aligns an element to the left.

center: Aligns an element to the center.

right: Aligns an element to the right.
itembadge
Type : string

Badge for the nav item.
itemchildren
Type : string

Children for the nav item.

Bindable: true
itemicon
Type : string

Class for the icon in the nav item.

Bindable: true
itemlabel
Type : string

Label for the nav item.

Bindable: true
itemlink
Type : string

Link for the nav item.

Bindable: true
layout
Type : string

This property controls how the nav items are displayed within the Nav

Allowed Values: none, stacked, justified

stacked: Nav items are show one above the other.

justified: Nav will be occupying full width and each nav item will have equal width.
name
Type : string

Name of the Nav.
orderby
Type : string

Allows to display the data in asc or desc order based on this property.

show
Type : boolean
Default value : true

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

Bindable: true
type
Type : string
Default value : 'pills'

This property controls how the nav items are displayed within the Nav

Allowed Values: pills or tabs

pills: Pills styles are applied to nav items

tabs: Tabs styles are applied to nav items
userrole
Type : string

User role for the nav item.

Bindable: true

results matching ""

    No results matching ""