File

projects/components/src/widgets/common/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

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.

Type : string

Default value : 'outsideClick'

class

Class of the widget.

Type : string

dataset

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

Bindable: true

Type : Array<any>

horizontalalign

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.

Type : string

itembadge

Badge for the nav item.

Type : string

itemchildren

Children for the nav item.

Bindable: true

Type : string

itemicon

Class for the icon in the nav item.

Bindable: true

Type : string

itemlabel

Label for the nav item.

Bindable: true

Type : string

itemlink

Link for the nav item.

Bindable: true

Type : string

layout

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.

Type : string

name

Name of the Nav.

Type : string

orderby

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

Type : string

show

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

Bindable: true

Type : boolean

Default value : true

type

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

Type : string

Default value : 'pills'

userrole

User role for the nav item.

Bindable: true

Type : string

result-matching ""

    No results matching ""