LogoLogo
What's NewDeveloper CommunitySupportStatus
  • 🚀Get Started
    • What is JourneyApps Platform?
    • Tutorial: Build your First App
      • 1. Introduction
      • 2. Create a new App
      • 3. OXIDE IDE Overview
      • 4. Hello World app
      • 5. The Data Model
      • 6. View Components
      • 7. Queries and Data Sync
      • 8. Simple Navigation
      • 9. View Stack
      • 10. Input Validation
      • 11. View Parameters
      • 12. Data Manipulation
      • 13. Responsive Apps
      • 14. Styling
      • 15. Lists
      • 16. GPS Capturing
      • 17. Relationships
      • 18. Multiple User Roles
      • 19. Deployment and Users
      • 20. Version Control
      • 21. CSV and APIs
      • 22. Conclusion
    • JourneyApps Platform Fundamentals
      • Creating a New App
        • Git-enabled Apps
      • What are Views?
      • What is the Data Model?
      • JourneyApps Syntax Basics
      • Access the Database (DB)
        • Manipulate DB Objects
        • Query DB Objects
      • View Navigation
        • Deep Linking
      • CloudCode Overview
      • OXIDE (Online IDE)
  • 💻Build your App
    • JourneyApps Syntax
      • Syntax Basics
      • Access the DB
      • View Navigation
      • Async & Await
      • TypeScript Apps (Beta)
        • runtime-build package
        • TypeScript App Troubleshooting
      • What's New in V4
        • Updating to the V4 API
    • Configure your Data Model
      • What is the data model?
      • Reference: model
        • field
        • belongs-to
        • has-many
        • index
      • Data Rules
        • Data Buckets
        • Sync Rules - Limit data synced to devices
        • Data ACLs - Limit access to data
        • Real-world example for Data Rules
        • ❔FAQs
        • Migrate to Data Rules
      • App Indexes
      • Webhooks
    • UI Components
      • All UI Components
        • actionSheet
        • Attachments
        • button
        • button-group
        • capture-coordinates
          • marker
          • marker-query
        • capture-file
        • capture-photo
        • capture-signature
        • card
          • accent
          • action
        • columns
          • column
        • component
        • context-menu
          • divider
          • item
        • CSV
        • date-input
        • datetime-input
        • dialog
          • body
        • display-3d-model
          • 📖display-3d-model Guides
            • Guide 1: Initialize and layout a 3D model in a view
            • Guide 2: Control playback position
            • Guide 3: Troubleshooting controls
        • display-coordinates
        • display-file
        • display-image
        • display-photo
        • display-signature
        • heading
        • html
          • HTML Advanced Topics
          • ❔HTML FAQs
          • 📖Guide: HTML & JourneyApps iFrame Client
        • icons
        • info
        • info-table
          • row
        • journey.photos (capture multiple photos)
        • JourneyPrinter (print PDFs)
        • grid
          • cell
          • 📖grid Examples
        • list
          • list-item
            • accent
            • asset
            • pills
              • pill
            • action
        • multiple-choice-checklist
        • navigation (Navigation drawer)
          • general-section
            • item
          • section
            • item
              • item
          • ❔navigation FAQs
        • notification
        • object-dropdown
        • object-list
          • action
        • object-repeat
        • object-table
          • action
          • column
            • action
            • edit-boolean
            • edit-date
            • edit-datetime
            • edit-integer
            • edit-number
            • edit-select
            • edit-text
            • edit-time
            • edit-typeahead
              • action
            • header-action
          • column-group
          • empty-action
          • 📖object-table Guides
            • Actions
            • Cell callouts
            • Column groups
            • Columns
            • Controlled object-table
            • Controls
            • Copy & paste data
            • Edit cells
            • Filters
            • Frozen columns
            • Fullscreen object-table
            • Mode
            • State
            • Styles
        • optionList
        • PhotonSync (transfer data offline)
        • power-bi
          • 📖Guide: PowerBI Embedding
        • scan-barcode
        • shortcut
        • sidebar
        • single-choice-dropdown
        • single-choice-radio
        • template
        • text-input
        • time-input
        • toggle
        • view
      • JS/TS Events
      • Show / Hide UI Components
      • View Templates
      • XML Fields (Attributes)
        • align-content
        • align-controls
        • align-label
        • bind
        • clear-button-visibility
        • control-order
        • disabled
        • error-message
        • icon-position
        • id
        • hide-if
        • modifier-text
        • label
        • label-case
        • label-color
        • on-change
        • on-press
        • placeholder
        • required
        • show-if
    • JS / TS APIs
      • Attachment
      • Bluetooth (Beta)
      • Broadcast
      • component
      • CSV
      • DB
      • HardwareBarcode
      • journey
        • journey.config
        • journey.container
        • journey.device
        • journey.diagnostics
        • journey.dialog
        • journey.files
        • journey.hardware
        • journey.photos
        • journey.runtime
        • journey.sensors
        • journey.viewStack
      • JourneyPrinter
      • KeyboardBarcode
      • LocalDB
      • NFC
      • OnlineDB
      • PhotonSync
      • SerialPort
      • ShortcutManager
      • TCPSocket
      • user
    • Extend your App with Custom Code
      • App packages
        • App packages overview
        • PDF report package
        • TypeScript library & unit tests
        • Manage External Dependencies
      • Custom HTML
    • Style & Customize your App
      • Style & configure UI components
        • Overview
        • Understand extendable themes
        • Use themes on a view
        • Theme specific components on a view
        • Examples
        • Debugging
        • ❔FAQs
      • Change your App Font
      • Custom Branding
        • Custom Container Features
        • Special Requirements for iOS Containers
    • Integrate your App
      • Backend integrations with CloudCode
      • Barcode Scanning
        • Barcode Scanning using Keyboard Emulation
        • Hardware Barcode Scanning
        • scan-barcode
      • Bluetooth Low Energy (BLE)
      • Broadcast API
      • HTTP requests (Fetch API)
      • JourneyApps Print (Android)
      • Maps and navigation
      • NFC
      • Opening external links/apps
      • Serial Port
      • TCP Sockets
    • Design Intuitive Apps
      • UX Guidelines
      • Write Effective Copy
  • 📱App Features
    • RealWear® Voice Control
      • Automatic Voice Commands
        • Automatic Voice Commands - Advanced
      • Manual Voice Commands
    • App, Runtime and Container Updates
    • Batch Operations (App)
    • Call JS/TS Functions from XML
    • Capture GPS Locations
    • Push Notifications
    • Translations
    • XML Format Strings
    • Webhooks (External)
  • 🌐CloudCode
    • CloudCode Overview
    • Trigger a CloudCode Task
      • Trigger CC with a Schedule
      • Trigger CC via a Webhook
      • Trigger CC from an App
      • Trigger CC from Another Task
      • Trigger CC via HTTP
    • Attachments in CloudCode
    • Timezones
    • Advanced CloudCode Topics
      • Access Multiple DBs in CloudCode Tasks
      • Batch API (CloudCode)
      • CloudCode Dependencies
      • Configure HTTPS in CloudCode
      • Deployment environment variables
      • Local CloudCode Development
      • PDF Reports using CloudCode
      • Shared CloudCode Tasks
      • Translations in CloudCode
  • 📥Backend API
    • Introduction
    • API Reference
      • Retrieve All Objects
      • Query Objects
      • Sort Results
      • Limit and Skip
      • Count Objects
      • Create a New Object
      • Retrieve a Single Object
      • Update a Single Object
      • Delete a Single Object
      • Batch Operations (v4 API)
      • Oplog API
      • Retrieve the App Data Model
      • Manage App Users and Sessions
      • Field Representation
      • Error Responses
    • API Limits
    • Update to the V4 API
  • ⚙️Technical
    • Data Synchronization Priority
    • Device Diagnostics
    • JSON1 Query Engine
    • Improve App Performance
    • Security Measures
    • Supported Platforms
      • Web Container
      • Windows Installer
    • Domain Whitelist
  • 🖥️OXIDE
    • Get started with OXIDE
      • OXIDE Overview
      • Components of OXIDE
    • Configure Testing Deployments
    • Edit and Manage Files
      • How to Navigate to a Function
      • Manage External Dependencies
    • Create and Manage App Containers
    • Debugging & Troubleshooting
      • Common Troubleshooting Pointers
      • App Diagnostics Reports
      • Build Logs
    • OXIDE Workspaces
      • OXIDE Trees
  • ❕Deprecated Features
    • Deprecated Features and Components
Powered by GitBook
On this page
  • Overview
  • Basic Example
  • Standard Attributes
  • label
  • validate
  • view
  • Advanced Attributes
  • args
  • collapsable
  • from-js
  • id
  • icon
  • icon-color
  • indicator
  • items
  • show-if and hide-if
  1. Build your App
  2. UI Components
  3. All UI Components
  4. navigation (Navigation drawer)
  5. section

item

PrevioussectionNextitem

Last updated 1 year ago

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"/>

<!-- 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 ];
}

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

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

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

Provide a label for a navigation item. Can be a static string, a or a .

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

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

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

See

💻
format string
JS/TS function
show-if
hide-if
id
icon
Component methods
navigation > indicator