Navigation Document

Last update: Edit

1 Introduction

A Navigation Document in Mendix Studio shows a configured menu of your app in a form of a tree. You can create items and sub-items in your navigation.

To open the Navigation Document, click the corresponding icon in the left menu bar.

Navigation Document Icon

The Navigation Document consists of menu items that allow end-users navigate your app or that perform certain actions. For example, you can configure a menu item to open a specific page or to log an end-user out of their profile. For more information on actions you can assign to menu items, see the Events Section.

You can also add a sub-item to a menu item. Mind that you cannot assign an action to the menu item that has the sub-item.

2 Navigation Editor Properties

In the navigation editor properties you can set a page or a microflow as a default home page.

The Default Home Page section consists of the following properties:

  • Page – Allows you to set a page that is opened when an end-user opens the page. A home page icon is displayed in a list of pages against a page that is set as a home page.
  • Microflow – Allows you to set a microflow that is performed when an end-user opens the app.

3 Menu Item Properties

Properties of the menu items consists of the following sections:

2.1 Events Section

You can choose the On Click Action in the Events section. The On Click Action defines what action is performed when the user clicks a menu item.

The available actions are described in the table below:

Action Description
Nothing No action is taken.
Page The specified page is opened.
Microflow The selected microflow is executed.
Save Changes Saves (commits) all changes made in the currently opened page and closes the page.
Cancel Changes Rolls back all changes made in the currently opened page and closes the page.
Close Page Closes the pop-up window (for pop-up pages) or navigates to the previously visited page. Note that this action will close the page and the changes if any will not be saved. Use Save Changes for this purpose.
Sign Out The current user is signed out of the app.
Open Link Triggers an action based on the link type:
  • Web – navigates to a website
  • Email – composes an email
  • Phone Call – starts a phone call
  • Text Message - sends a text message
Note When you configure Email, Phone Call or Message options, the corresponding default app will be opened on the device when the action is triggered, for example, the default email client will be opened to compose a message.

2.2 General

The properties that can be configured in the General section are the following:

  • Caption – Allows you to fill in the name of the menu item.
  • Icon – Allows you to set the icon of the menu item.

3 Creating a Menu Item

To create a new menu item, do the following:

  1. Click the Navigation Document icon in the left menu bar to open the Navigation.

  2. Click a plus at the bottom of the navigation tree to create a menu item, or click a plus next to the existing navigation item to create its sub-item

  1. Specify the properties of the created item if needed (For more information, see Properties of Menu Items).

A new menu item or a sub-item is added to the navigation.

4 Read More