item

Overview

Items are destinations that users can navigate to. An item is associated with a single view in your app. When a user clicks on an item, they will be navigated to its associated view automatically.

The hamburger icon is present on any view that has an associated item the navigation drawer.

An item can be a parent or a child. Parent items can be set to be collapsable, in which case a caret will display next to the item that will show and hide its children on toggle.

An icon can be specified for an item, and will be placed on the left of its text.

Basic Example

item best practices

Naming a view

View names should be:

• short and concise

• devoid of action words (e.g. use "Sites" instead of "View sites")

Collapsible items

When deciding whether parent items with children should be collapsable or not - have a look at the amount of content in the navigation drawer as a whole. If it contains a lot of items, make parent items collapsable so that all/most parent items are visible without scrolling. If the drawer is fairly empty, and most children items are visible without scrolling, don’t make parent items collapsible.

Standard Attributes

label

<item label="{$:getSiteName()}: Summary"/>

Provide a label for a navigation item. Can be a static string, a format string or a JS/TS function.

<!-- XML -->
<navigation >
    <section >
        <item label="Sites"/>
        <!-- Other navigation items here -->
    </section>
</navigation>

label best practices

View names should be:

• short and concise

• devoid of action words (e.g. use "Sites" instead of "View sites")

validate

<item label="User details" view="user/details" validate="true">

Optional

Default: false

Validation will check all required fields on the view and confirm that they contain values. In the case validation fails, the user cannot navigate to another item on the navigation drawer.

<item label="Home" view="main"/>
<item label="User details" view="user/details" validate="true"/>

Validation on navigation items operate differently from validation on other view components. Validation is performed on the view that corresponds to the item that has validate="true" specified and not the target item being navigated to.

view

<item view="users">

The view attribute ties a destination to a particular view path. The user will be navigated to that view.

<!-- XML -->
<item label="Site" view="site"/>

The navigation drawer will only be visible on views which has corresponding view paths specified.

In the case a parent item has no view specified and is collapsable, the item will behave in a similar way a collapsable section behaves.

Advanced Attributes

args

<item args="$:buildItemArgs()">

In the case where the view being navigated to expects view parameters, we pass arguments using args=$:function(). The $:function() should return an array of values that match the number and type of the expected view parameters.

Example: The view with view path site expects two parameters, the current user and the current site.

<!-- XML -->
<item label="Site" view="site" args="$:getSiteArgs()"/>

// JS
function getSiteArgs() {
    return [ user, view.currentSite ];
}

In the case where multiple items reference the same view path, please see the id reference on how to manually set the active item.

collapsable

<item collapsable="true"/>

Default: false

Specify that the parent item should be collapsable.

<!-- XML -->
<navigation >
    <section >
        <item label="Site" view="site" collapsable="true">
            <item label="Equipment" view="equipment" />
        </item>
    </section>
</navigation>

collapsable="true" will only be applied to a parent item if it contains children items.

collapsable best practices

When deciding whether parent items with children should be collapsable or not - have a look at the amount of content in the navigation drawer as a whole. If it contains a lot of items, make parent items collapsable so that all/most parent items are visible without scrolling. If the drawer is fairly empty, and most children items are visible without scrolling, don’t make parent items collapsible.

from-js

<item from-js="$:buildItemFromJS">

Construct a navigation item from JavaScript/TypeScript, using a $:function() that returns an array of component.navigationItem objects.

<!-- XML -->
<item from-js="$:buildItemFromJS()"/>

// JS
function buildItemFromJS() {
    // Your logic here
    return component.navigationItem({
        label: "Users",
        view: "users",
        id: "js-item",
        args: function() {
            return [ user ];
        },
        icon: "icons/man.png",
        collapsable: true,
        items: buildSubItems()
    });
}

function buildSubItems(){
    // Logic to construct an array of component.navigationItem objects
}

id

<item id="{$:getItemId()}"/>

Type: Format string

Default: unset

The id attribute is used to target the item when triggering a component method. See Component methods for more detail.

icon

<item icon="fa-bomb">

Specify an icon for a navigation item. String representing a font-awesome, ionicon or png icon.

<!-- XML -->
<item label="Site" view="site" icon="$:getSiteIcon()"/>

// JS
function getSiteIcon() {
    // Logic here
    return "icons/site.png";
}

icon-color

Specify a color for an item's icon using icon-color="my-named-color". Supports named colors and #HEX values.

indicator

See navigation > indicator

items

<item items="$:buildItems()"/>

In a section, the item element can be nested to a maximum depth of two.

Construct a parent item's items from JavaScript/TypeScript using a function that returns an object array of type navigationItem.

<!-- XML -->
<navigation >
    <section>
        <item label="Users" view="users" items="$:buildItems()" collapsable="true"/>
    </section>
</navigation>

// JS
function buildItems() {
    var paths = ["operators", "admins"];

    return ["Operators", "Administrators"].map(function(item, idx) {
        return component.navigationItem({
            label: item,
            view: paths[idx]
        });
    });
}

show-if and hide-if

pageshow-ifpagehide-if