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
  • Configuration
  • Dynamically Generated Sidebars
  • Basic Example
  • Example 1 using SharedJS
  • Example 2 using SharedJS
  1. Build your App
  2. UI Components
  3. All UI Components

sidebar

PreviousshortcutNextsingle-choice-dropdown

Last updated 5 months ago

This UI component displays a sidebar with items on the left side of the screen on desktop and tablets, to indicate to the user how far they are progressing with a process.

Sidebar hidden by default on small screens

By default the sidebar is not shown if the app is used on devices with smaller screens (< 768px). This behavior can be changed in its configuration.

The text contained inside the <sidebar> tag can be a , meaning that you can make the text dynamic.

<sidebar>
    <item state="normal" icon="ion-ios-clock-outline">Pending</item>
    <item state="normal" icon="ion-ios-redo-outline">Dispatched</item>
    <item state="active" icon="ion-ios-location-outline">Arrived</item>
    <item state="disabled" icon="ion-ios-gear-outline">Work Started</item>
    <item state="disabled" icon="ion-ios-checkmark-outline">Closed</item>
</sidebar>

Sidebar Priority

The sidebar must be the first component listed in the View XML.

Configuration

sidebar

Option
Required
Details

position

optional

Specifies the position of the sidebar. Can be left or right. Can also be specified by returning a value from a function. Defaults to left. Note that the position of the sidebar will only update after a view transition.

items

optional

Function which returns an array of component.sidebarItem objects. Note: If items= is specified, the sidebar cannot contain any <item> children.

visible-on-mobile

optional

Boolean indicating whether or not to show the sidebar on mobile. Can be either "true" or "false". Defaults to "false"

item

Option
Required
Details

state

optional

The way the sidebar item is visually rendered, to indicate to the user whether they have already completed the step indicated by the sidebar item in a process. It can be one of the following:

  • normal: The sidebar item is shown normally — should be used for steps in a process that the user has already completed.

  • active: The sidebar item is highlighted — should be used to indicate that the user is currently at the step in the process indicated by this sidebar item.

  • disabled: The sidebar item text and icon is greyed out — should be used for steps in a process that the user has not yet completed.

In other words, exactly one field should be active. All fields before it should be normal, and all fields afterwards should be disabled. Defaults to normal

icon

optional

Path of the icon to display on the sidebar item, left of the text. Icons can be uploaded using the Assets workspace in OXIDE.

icon-color

optional

Sets the icon's color. Can be a named color, like primary or a hex value, like #008000. Can also be specified by returning a value from a function. Return null to use the icon's default color. Was added in version 4.36.0 of the JourneyApps Container.

show-if

optional

hide-if

optional

The opposite of show-if (see above).

on-press

optional

Function to call when the item is pressed - either a JavaScript/TypeScript function or a navigation function. Note: Adding on-press to an item adds a right chevron icon to its right-hand-side.

on-press-icon

optional

The Ionicon to display on the right-hand-side of the item, typically denoting the action. Defaults to ion-chevron-right

validate

optional

Whether to run field validation before calling the associated on-press (see above). Can be either true, false, or the result of a function, e.g. ($:shouldBeValidated()).

Dynamically Generated Sidebars

Version compatibility

The feature to generate sidebars dynamically was introduced in version 4.38.5 of the JourneyApps Container.

<sidebar items="$:getItems()">
<!-- Cannot have <item> here if items= is defined -->
</sidebar>

The function in items= must return an array of component.sidebarItem objects. component.sidebarItem has the following properties:

{
    label: string;
    state: string;
    icon: string;
    iconColor: string;
    onPress: function;
    onPressIcon: string;
    validate: boolean;
}

Implicit show-if and hide-if

Note that the items specified above do not have showIf or hideIf fields. All items added to the array will automatically be shown. In order to hide an item, omit it from the returned array.

Basic Example

<sidebar items="$:getItems()" />
function getItems() {
  var items = [];
  items.push(
    component.sidebarItem({
      label: 'Home',
      onPress: function() {
        link.home();
      }
    })
  );
  items.push(
    component.sidebarItem({
      label: 'Orders',
      state: 'active'
    })
  );

// You can also construct a sidebarItem like this:
  var thirdItem = component.sidebarItem();
  thirdItem.label = 'Staff';
  thirdItem.onPress = function() {
    link.staff();
  };
  thirdItem.icon = 'fa-user-astronaut';
  items.push(thirdItem);

  return items;
}

Example 1 using SharedJS

<sidebar items="$:getSharedItems()" />
// In your app's SharedJS
function getSharedItems() {
    return [
        component.sidebarItem({ label: 'Item 1' }),
        component.sidebarItem({ label: 'Item 2' })
    ];
}

Example 2 using SharedJS

<sidebar items="$:getItems()" />
// In your app's SharedJS
function getItemsInSharedJS() {
    return [
        component.sidebarItem({ label: 'Item 1' }),
        component.sidebarItem({ label: 'Item 2' })
    ];
}

// In your view's JS
function getItems() {
    return getItemsInSharedJS().concat([
        component.sidebarItem({
            label: 'Item 3'
        })
    ]);
}

Controls whether the sidebar item is hidden or shown. The argument specified to show-if can either be a literal boolean value (true or false), or it can specify a variable, parameter or field that can be a string, number, object, etc. that evaluates to false or evaluates to true (see the reference documentation for and for further details)

💻
show-if
hide-if
formatted string