Nav

The nav object is a navigation menu that allows users to navigate between pages or to perform actions.

It can be used to create a navigation bar, a menu, or a toolbar.

It can contain buttons, groups, sub menus and more.

Markdown tutorial

Attributes

Common

ID

Sets the object's ID.

The ID identifies the object and is used to reference it in UISet actions, allowing to change its attributes dynamically.

The ID is not unique, it can be shared among multiple objects to quickly change a common attribute.

IDs can't be changed with a UISet action, but they can have a Value Binding assigned to them. Value Bindings on IDs allow an object to be dinamically attached to a set of attribute values.

E.g. the following Value Binding switches the ID of the object between mybutton1 and mybutton2 based on the value of the UISet button.address:

Value binding:

="mybutton" + ui('button', 'address')

UISet:

UISet('button', 'address', '1') switches the ID to mybutton1

UISet('button', 'address', '2') switches the ID to mybutton2

Position and Size

Position

Sets the object's position.

The default value is: x0y0.

Attribute Values

Value	Description	Example
x<left>y<top>	Specify left/top coordinates in pixels.	x10y20

Flex Grow

Specifies if the objects should grow to fill the available space.

The default value is: true.

Attribute Values

Value	Description
true	Default value. Objects expand to fill the available space.
false	Objects do not grow to fill the available space.

Flex Shrink

Specifies if the objects should shrink to fit the available space.

The default value is: true.

Attribute Values

Value	Description
true	Default value. Objects shrink to fit the available space.
false	Objects do not shrink to fit the available space.

Width

Sets the object's width in pixels.

Minimum value is 1.

Height

Sets the object's height in pixels.

Minimum value is 1.

Size

Size Open

Specifies the size of the nav when open.

Attribute Values

Value	Description
<int>	Width or height (depending on orientation) in number of pixels.

Layout

Mode

Specifies the nav's mode which affects the way it appears and it's positioned.

In "drawer" mode, nav has closed/open states, which can be controlled with a hamburger button, defined in the Items attribute. When closed the nav is narrower and buttons appear without labels. When it's opened it expands up to the width specified in the Width Open attribute. The push attribute specifies if the content of the page is pushed aside when opening.

The "offscreen" mode is similar to drawer, but when closed the nav is completely hidden.

The default value is: static.

Attribute Values

Value	Description
static	Default value. Static position.
drawer	Drawer mode.

Side

Specifies which sides the nav is aligned to.

The default value is: none.

Attribute Values

Value	Description
none	Default value. Stick to the left side.
left	Stick to the left side.
right	Stick to the right side.
top	Stick to the right side.
bottom	Stick to the right side.

Orientation

Specifies the nav orientation.

The default value is: horizontal.

Attribute Values

Value	Description
horizontal	Default value. Horizontal.
vertical	Vertical.

Items

Items

Specifies the nav's items.

For the full item reference, see Nav Item.

Attribute Values

Value	Description	Example
<JSON array>	Description of the nav's content.	[{"type":"button","label":"Home","action":"link","link":"home"}]

Popup Menu Font

Popup Font Family

Specifies the font family.

The default value is: default.

Popup Font Size

Specifies the font size in pixels or percentage (relative to the project's font size).

The default value is: 14.

Attribute Values

Value	Description	Example
<integer>	Font size in pixels.
<percentage>%	Relative font size in percentage.	90%

Popup Font Color

Specifies the text CSS color.

Attribute Values

Value	Description	Example
<html color>	Color in any html accepted format.	#ff0000

Popup Font Weight

Specifies the weight of the font.

The default value is: normal.

Attribute Values

Value	Description
normal	Default value. Normal.
bold	Bold.
bolder	Bolder.
lighter	Lighter.

Popup Italic

Show the text in italics.

The default value is: false.

Attribute Values

Value	Description
false	Default value. Normal.
true	Italics.

Popup Small Caps

Sets the font to small caps.

The default value is: false.

Attribute Values

Value	Description
false	Default value. Normal.
true	Small caps.

Popup Decoration

Specifies the text decoration.

The default value is: none.

Attribute Values

Value	Description
none	Default value. No decoration.
underline	Underline.
overline	Overline.
line-through	Line through.

Popup Line Height

Sets the line height of the text.

The default value is: 1.0.

Attribute Values

Value	Description
<float>	Specify the line height as a multiple of the font size.

Items

Hidden Items

Specifies the nav hidden items in drawer mode, that appear when the drawer opens.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

For the full item reference, see Nav Item.

Attribute Values

Value	Description	Example
<JSON array>	Description of the nav's content.	[{"type":"button","label":"Settings","action":"link","link":"settings"}]

Drawer

Open

Specifies if the nav is open. Toggle this value to show/hide the nav.

The default value is: false.

Attribute Values

Value	Description
false	Default value. Nav is closed.
true	Nav is opened.

Push

If true, pushes the page's content out of the way when opening.

The default value is: true.

Attribute Values

Value	Description
true	Default value. Pushes the page's content.
false	Opens on top of the page's content.

Close On Select

Specifies if selecting a drawer menu item closes it (if it's currently open).

The default value is: true.

Attribute Values

Value	Description
true	Default value. When the user clicks a menu item, it closes.
false	The drawer must be closed manually with the hamburger button or by setting the open attribute.

Style

Panel

Shows a panel that frames the object. Its style can be modified.

The default value is: true.

Attribute Values

Value	Description
true	Default value. Shows the panel.
false	Hides the panel.

Panel Color

Specifies the panel color.

The default value is: true.

Attribute Values

Value	Description
default	Default color.
primary	Primary color, used to highlight important areas.
warning	Warning color, used to highlight warning areas.
success	Success color, used to highlight success areas.
error	Error color, used to highlight error areas.
red,blue,yellow,green,yellow,purple,orange,green	Palette colors.
custom	Custom color, defined in the "Custom Color" attribute.

Panel Custom Color

Specifies the panel custom color.

The default value is: true.

Attribute Values

Value	Description	Example
<html color>	Color in any html accepted format.	#ff0000

Gap

Specifies the space between the nav's items.

The default value is: auto.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Attribute Values

Value	Description
auto	Default value. Auto.
<int>	Gap in pixels.

Icon Size

Specifies the icon size.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Attribute Values

Value	Description
<int>	Icon size in pixels.

Button Color

Specifies the button color.

The default value is: default.

Attribute Values

Value	Description
default	Default value. Default color.
primary	Primary color, used to highlight action buttons.
warning	Warning color, used to highlight warning buttons.
success	Success color, used to highlight success buttons.
error	Error color, used to highlight error buttons.
light	Light color.
dark	Dark color.
red,blue,yellow,green,yellow,purple,orange,green	Palette colors.
custom	Custom color, defined in the "Custom Color" attribute.

Button Custom Color

Specifies the button's custom color.

The default value is: clear.

Attribute Values

Value	Description
<html color>	Any valid HTML color.

Button Look

Specifies the button's look.

The default value is: clear.

Attribute Values

Value	Description
filled	Filled look, with a solid background.
clear	Default value. Clear look, no background or border.
outlined	Outlined look, with a solid border.
glass	Glass look, with a semi-transparent background.

Button Icon Position

Specifies the position of the button's primary icon.

The default value is: left.

Attribute Values

Value	Description
left	Default value. Left.
top	Top.

Button Section Icon Position

Specifies the position of the button's primary icon inside a section.

The default value is: left.

Attribute Values

Value	Description
left	Default value. Left.
top	Top.

Highlight Mode

Specifies the way selected buttons are highlighted.

The default value is: border.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Attribute Values

Value	Description
border	Default value. Border highlight.
fill	Filled button highlight.
dot	Dot highlight.

View

Visible

Sets the object's visibility.

The default value is: true.

Attribute Values

Value	Description
true	Default value. Visible.
false	Hidden.

Enabled

Specifies if the object is enabled or disabled. A disabled object appears as grayed out and can't be interacted with.

The default value is: true.

Attribute Values

Value	Description
true	Default value. Enabled.
false	Disabled.

Blink

Blinks the object at the specified speed.

The default value is: false.

Attribute Values

Value	Description
false	Default value. Not blinking.
slow	Blinks slowly.
fast	Blinks fast.

Transition

Specifies the transition effect when the object is shown or hidden.

The default value is: none.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Attribute Values

Value	Description
none	Default value. No transition.
fade	Fade in/out.
fade-left	Slide from left and fade in/out.
fade-right	Slide from right and fade in/out.
fade-up	Slide from top and fade in/out.
fade-down	Slide from bottom and fade in/out.
slide-left	Slide from left.
slide-right	Slide from right.
slide-up	Slide from top.
slide-down	Slide from bottom.
zoom-in	Zoom in.
zoom-out	Zoom out.
3d-flip-left	3D flip from left.
3d-flip-right	3D flip from right.

Transition Duration

Specifies the transition duration in milliseconds.

The default value is: 300.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Attribute Values

Value	Description
<integer>	Duration in milliseconds.

Transition Delay

Specifies the transition delay in milliseconds.

The default value is: 0.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Attribute Values

Value	Description
<integer>	Delay in milliseconds.

Opacity

Sets the object's opacity. Opacity is the degree to which content behind an object is hidden.

The default value is: 1.0.

Attribute Values

Value	Description
0	The object is fully transparent.
>0.0, <1.0	The object is translucent (content behind the element can be seen).
1.0	Default value. The object is fully opaque.

CSS Class

Specifies a CSS Class that applies to the object, useful to customize its appearance. Custom CSS Classes are specified within the custom.css file.

Margin

Specifies the margin of the object. The margin is the space outside the object's border.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Attribute Values

Value	Description	Example
<int>	Specify the margin in pixels for all sides of the object.
<top> <right> <bottom> <left>	Specify the margin in pixels for each side of the object.	10 20 30 40

View Scale

Specifies the scale of the object. The scale is the ratio between the object's size and the size of the view it is contained in.

The default value is: 1.0.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Attribute Values

Value	Description
<float>	Specify the scale for both width and height of the object.

Meta

Comment

Specifies a comment, visible only in the Project Editor. It can be used to add a note or a tag to the object. The filter in the object's SELECT panel applies to the comment as well.

note

This attribute is static. Its value can't be changed dynamically with a uiSet command or with a value binding.

Exclude

Excludes the object from the UI. Useful to temporarily hide an object without deleting it. Different from the "Visible" attribute, which hides the object in the UI but keeps it in the project, allowing it to be shown again with a UISet.

The default value is: false.

note

This attribute is static. Its value can't be changed dynamically with a uiSet command or with a value binding.

Attribute Values

Value	Description
false	Default value. Object is included in the UI.
true	Object is excluded from the UI.