The NavigationBar widget manages contents in window or in application-specific drop down menus which are grouped in a parent menu. Mostly, it is anchored to the top of the screen or a window.


  • UI Type:

Extends: BaseWidget

Properties

Name Desciption
DisabledThe widget cannot be used.
Form
HiddenHides the widget from the user.
Icon
Tab IndexThe Tab Index is an integer that tells the order of the widget when using the tab-key to move from one widget to another.

Style

Name Desciption
Active menu backgroundThe background color of the active menu item in navigation bar.
Active menu colorThe text color of the active menu item in navigation bar.
Active menu hover backgroundThe background color on hover state of the active menu item in navigation bar.
Active menu hover color
Background-colorChange background color of the widget.
ColorColor of the text inside the widgets. May not apply to all text inside all widgets.
Fixed button width (in rem)
Fixed width for all buttons
Font SizeSet the font size in pixels for text.
Menu border radiusAdd curves to the borders of the items in navigation bar.
Menu hover backgroundThe background color of navigation menu items in hover state.
Menu spacingGenerate space between items of the navigation bar.
Stacked vertical menuEnable vertical layout for the navigation bar.
Text-alignmentSet left, centered or right. Applies both to icon and text.
Vertical space for stacked menuGenerate space between items of the navigation bar.

Events

Name Description Event Attribute
Blur Event when a widget goes out of focus.
event The event that gets triggered when the user "leaves" an element.
Click Event that triggers based on touch or click.
event The event that triggered the handler.
DblClick Event that triggers based on double click.
event The event that triggered the handler.
Focus Event when indicating/ highlighting widget using the cursor.
event Focus is the event that gets triggered when a user makes an element come into focus, by clicking on it.

Function

blur ( )

Triggers the blur event.

focus ( )

Triggers the focus event.

get ( name: String ) →{ Object }

Gets the value of the specified property.

Parameters
Name Type Description
name String The name of the property.
Returns

The property's value.

getId ( ) →{ ID }

Returns the ID of the widget.

Returns

The ID of the widget

getValue ( ) →{ Object }

Returns the widget's value.

Returns

The widget's value.

hide ( )

Hides the widget.

isEnabled ( ) →{ Boolean }

Returns true if the widget is enabled.

Returns

True if enabled, otherwise false.

isHidden ( ) →{ Boolean }

Returns true if the widget is hidden.

Returns

True if hidden, otherwise false.

set ( name: String , value: Object )

Sets the value of the specified property.

Parameters
Name Type Description
name String The name of the property.
value Object The new value.

setEnabled ( Enabled: Boolean )

Enables/disables the widget.

Parameters
Name Type Description
Enabled Boolean True to enable the widget, false to disable.

setStyle ( Object: Object )

Set the widget-style

Parameters
Name Type Description
Object Object properties

setValue ( value: Object )

Sets the widget's value.

Parameters
Name Type Description
value Object The new value.

show ( )

Shows the widget.