navigation (Navigation drawer)
Last updated
Last updated
The navigation drawer is a somewhat omnipresent element that slides in from the left, by means of toggling the hamburger icon located at the top left of the title bar. The hamburger icon is present on any view that is listed in the drawer. These items should reflect the high level views in your app. The hamburger icon will be replaced by either a back or close icon on views that aren’t listed in the drawer - these views are seen as deeper levels within the app’s hierarchy.
The navigation drawer should be reserved for global items. Even though items can be built and displayed dynamically, they should be kept as static as possible per user role. This is analogous to a map not changing while it's in use.
A successful navigation system serves as a map, in that it:
provides an overview of the content included in an app
reinforces the relationship between different sections of content, and
acts as a “You are here” sign, indicating how the user’s current screen fits into the bigger picture
First time users might feel lost without it, as they won’t know what to expect of an app. It can also save returning users a lot of time by optimizing frequently used flows.
navigation anatomyThe header will become collapsable and the logo replaced by the name of the app when either
the content in the drawer is longer than the height of the drawer,
the screen height is less than the drawer’s height
logoOptional
Type: string
Default: unset
Specify the brand logo to be displayed in the navigation drawer. String or $:function() that returns a string.
from-jsOptional
idindicatorOptional
Default: The global indicator will by default only show if there are other indicators in the drawer. The style of the global indicator is derived using the following, for instance if all indicators are of type number the global indicator will be the sum of these.
Indicators can be used to draw the user’s attention to the status of an item or the navigation drawer globally. An example is showing a certain amount of unread messages. Indicators can contain either numbers, text or be empty. The color can also be customized.
An indicator can be placed either of the following elements of the navigation component:
Globally. The indicator will appear with the hamburger menu, overriding an item indicator that by default shows here (see next bullet).
On an item. When an item indicator is present, in addition to displaying with the corresponding item, an additional indicator will also display with the hamburger icon (unless a global indicator is defined).
indicator best practices
Use an indicator if:
it is important for the user to be aware of an item's status, even when busy with another task
it is beneficial to draw the user's attention away from their current task
color attribute: Stick to predefined app colors, to ensure a coherent palette when displayed together.
value attribute: When displaying text, use short clear words, like "Pending".
sectionsOptional
Build navigation sections from JavaScript/TypeScript, using a function that returns an array of component.navigationSection objects.
show-if and hide-ifstyle-header-backgroundOptional
Type: string - can be a named color or #HEX value
Default: unset
Specify the background color of the navigation drawer.
style-section-caseOptional
Type: uppercase | lowercase |sentence-case | title-case | none
Default: uppercase
Configure the letter case of section labels.
style-section-colorOptional
Type: string - can be a named color or #HEX value
Default: primary
Specify the font color of section labels.
showcomponent.getNavigation().show()
Programmatically open the navigation drawer, under the following conditions:
The active view is listed in the navigation drawer.
The hamburger menu is visible, i.e. the view is the only view on the stack.
hidecomponent.getNavigation().hide()
Hide the navigation drawer programmatically. This operation follows the same conditions as listed above.
setActivecomponent.getNavigation().setActive({id:'myId'})
When using a generic view that displays differently based on the view parameter values. It is a common pattern to have multiple navigation items listed in the drawer that all refer to the same view path.
In this case, the drawer will not distinguish between which of those items corresponds to the active view.
In this case it is required to manually set the active view, using id="myId" and component.getNavigation().setActive({id:'myId'}) in init().
Site view code
Breaking change
In version 4.57.2 of the JourneyApps Runtime, component.getNavigation().byId('myId').setActive() was changed to component.getNavigation().setActive({id:'myId'}).
Please update all affected view code.
setOpencomponent.getNavigation().setOpen({id:'myId'})
Programmatically toggle a collapsable <section/> or <item/> to an open state. This will persist across view transitions.
Use case: Open a section after a user has performed a particular task or action.
setCollapsedcomponent.getNavigation().setCollapsed({id:'myId'})
Programmatically toggle a collapsable <section/> or <item/> to a collapsed state. Similar to setOpen this will, persist across view transitions.
Use case: Collapse all items in the drawer except for a particular set of items, focussing the user attention.
Brand
The top part of the navigation drawer, also referred to as the header, is reserved for customer or app branding. Here you can add a and set the to give the navigation drawer a customized look.
Construct a navigation component from JavaScript/TypeScript using a that returns a component.navigation object.
The following component methods are available when an is assigned to the component and component.getNavigation({id:'my-id'}).xxx is called from JS/TS:
