Persistent Menu Navigation
This feature requires a CommCare Software Plan
This feature is only available to CommCare users with an Advanced or above plan. For more details, please see CommCare Pricing Overview
The Persistent Menu Navigation feature enhances navigation within Web Applications by displaying a menu on the left-hand side of the screen. This menu allows users to move quickly between different sections of the application without having to return to previous screens manually.
This feature is particularly beneficial for applications requiring frequent navigation across multiple menus and forms. Users can view the full structure of the application at a glance and jump directly to their desired location with a single click.
Setup
To enable the Persistent Menu:
Log into CommCareHQ
Select the application for which you would like to enable the Persistent Menu
Navigate to the app settings page by clicking on the gear icon next to the Application Name
In the “Web Apps Settings” section, check “Show Persistent Menu”
Select the application name in the upper left hand corner to proceed to the Release Page
Make a new version of your application
Mark the new version as “Released”
Please note that the breadcrumbs bar remains accessible for applications; however, it can be disabled if only the Persistent Menu is required.
Items Displayed within the Persistent Menu
The Persistent Menu functions similar to the breadcrumbs bar by displaying the navigation path leading to the current screen. In addition, it also provides quick access to other relevant menus and forms that are part of the same workflow.
For example, in an application called "Random", the user is in the "Numbers" case list and has opened the "Register" form. The Persistent Menu displays (refer the screenshot):
The full path leading to the "Register" form (i.e., "Random" > "Numbers" > "Register")
Other menus or case lists at the same level as "Numbers"
Other forms available within "Numbers," such as the "Followup" form
However, menus and forms from unrelated sections of the app will not be shown. If the user moves away from the "Numbers" menu, the "Register" and "Followup" options will no longer be visible. Instead, new relevant options for the selected menu will appear.
Hover and Lock behavior
When the user hovers over the Persistent Menu, it expands as an overlay on top of the application’s interface. Once the cursor moves away, the menu collapses back.
If the user clicks the arrow button on the expanded menu, it locks in place and remains open. In this locked state, the menu is displayed alongside the main content. The menu remains open as the user continues navigating within the application.
