Skip to content

Commit 62255ab

Browse files
committed
Update general navigation profle docs as well
1 parent 6d4e0fb commit 62255ab

2 files changed

Lines changed: 25 additions & 2 deletions

File tree

content/en/docs/refguide/modeling/app-explorer/app/navigation/_index.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,9 @@ The core of Mendix's navigation model is founded on the following profiles:
2525
* Phone web
2626
* Phone web offline
2727
* Native mobile (tablet & phone)
28+
* Embedded (Beta)
2829

29-
Users that access the app via a particular device type are automatically redirected to the homepage of the appropriate profile based on the profile type (for details, see the [Redirection to Profiles](#redirection) section below).
30+
Users that access the app via a particular device type are automatically redirected to the homepage of the appropriate browser or mobile profile based on the profile type (for details, see the [Redirection to Profiles](#redirection) section below). The Embedded profile is not selected through device detection. It is used when a host application loads the embedded client.
3031

3132
The device type of the currently logged-in user is available in [microflows](/refguide/microflows/) as the `$currentDeviceType` variable. The type of this variable is the [enumeration](/refguide/enumerations/) `System.DeviceType`, which has the values `Phone`, `Tablet`, and `Desktop`. You can use `$currentDeviceType` to perform different actions based on the device type. A typical example is to show different pages based on the device type.
3233

@@ -56,6 +57,12 @@ The Mendix app will run in [offline-first](/refguide/offline-first/) mode. This
5657
You are required to enable anonymous users in your app's security settings and include anonymous user roles on native login pages. This is because there is no built-in login screen in the native profile; login pages are modeled as regular native pages.
5758
{{% /alert %}}
5859

60+
### Embedded
61+
62+
The Embedded profile lets you use a Mendix web app as a component inside another web application. The host application loads the embedded client and owns browser-level navigation, while the Mendix app renders and navigates inside its mounted region.
63+
64+
The Embedded profile defines a default home page and can also define an error page. When the configured home page expects page parameters, the host application can pass them through the `parameters` object in `render(...)`. For more information, see [Embedding the Client](/refguide/mendix-client/embedding-the-client/).
65+
5966
## Redirection to Profiles {#redirection}
6067

6168
Mendix Runtime automatically redirects users to the home page of the appropriate device type based on the device they are using. This happens by examining the `User-Agent` string that is sent by the device. The default configuration for this redirection is as follows:
@@ -98,6 +105,8 @@ The default home page indicates which [page](/refguide/page/) or [microflow](/re
98105
The default home page is visible to all unauthenticated users.
99106
{{% /alert %}}
100107

108+
For the Embedded profile, the default home page is the first page shown when the host application calls `render(...)`.
109+
101110
#### Role-Based Home Pages{#role-based}
102111

103112
By using role-based home pages, you can show different home pages for different users. If a user logs in, the first role-based home page of which the user role matches the user role of the user is displayed. If no match is found, the default home page is used.
@@ -108,6 +117,10 @@ For each role-based home page, you can specify the user role it applies to and t
108117

109118
The fallback page is a page or microflow that can be used to customize the application's behavior when trying to access a [microflow](/refguide/microflow/#url) or [page](/refguide/page-properties/#url) URL that does not exist. For more information, see [Setting a Fallback Page](/refguide/setting-up-the-navigation-structure/#fallback) in *Setting Up Navigation*.
110119

120+
#### Error Page
121+
122+
For Embedded profiles, you can configure an error page. This page is shown when the embedded app cannot open the configured home page during startup or navigation. Examples include page parameter values passed through `render(...)` that do not match the expected parameter types, or a configured home page that is not accessible for the signed-in user. For more information, see [Embedding the Client](/refguide/mendix-client/embedding-the-client/).
123+
111124
### Authentication {#authentication}
112125

113126
If a user, [anonymous](/refguide/anonymous-users/) or authenticated, tries to access a resource to which the user has no access, the configured [sign-in page](/refguide/authentication-widgets/) will be displayed, prompting the user to sign in.
@@ -145,4 +158,5 @@ For more details on the settings and when to use them, see the [Offline-First Re
145158
## Read More
146159

147160
* [App Explorer](/refguide/app-explorer/)
161+
* [Embedding the Client](/refguide/mendix-client/embedding-the-client/)
148162
* [Navigation Tree](/refguide/navigation-tree/)

content/en/docs/refguide/modeling/app-explorer/app/navigation/setting-up-the-navigation-structure.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ aliases:
88
---
99
## Introduction
1010

11-
Once your app has some pages, create a navigation menu to give your users access to them. The navigation editor allows you define the navigation menu for different type of apps and devices (for example, for responsive, tablet browser, or native mobile apps). It also allows you to define which page is shown as a default home page depending on the user role.
11+
Once your app has some pages, create a navigation menu to give your users access to them. The navigation editor allows you define the navigation menu for different type of apps and devices (for example, for responsive, tablet browser, native mobile, or embedded apps). It also allows you to define which page is shown as a default home page depending on the user role.
1212

1313
## Setting a Default Home Page {#home}
1414

@@ -35,6 +35,8 @@ Do the following:
3535
For online profiles, you can set a microflow as a default home page. Make sure a [Show Page](/refguide/show-page/) activity is called from the startup microflow for each possible execution flow. Otherwise, the user will see nothing during execution paths where the activity is missing.
3636

3737
For the native mobile profile, you can set a nanoflow as a home page, either as a default or as a role-based. For more information, see the [Setting a Nanoflow as a Home Page](#nanoflow-home-page) section below.
38+
39+
For the Embedded profile, the selected home page is the first page shown when the host application calls `render(...)`. When that page requires parameters, the host application passes them through the `parameters` object in `render(...)`. For more information, see [Embedding the Client](/refguide/mendix-client/embedding-the-client/).
3840
{{% /alert %}}
3941

4042
Now every time a user signs in to the application, the selected page/microflow is shown/triggered.
@@ -74,6 +76,12 @@ If a microflow is used as a fallback, it can have only one String parameter name
7476

7577
The fallback page will only be used for URLs that start with a [URL Prefix](/refguide/runtime-tab/#url-prefix).
7678

79+
## Setting an Error Page for an Embedded Profile
80+
81+
The Embedded profile can use an error page when the configured home page cannot be opened during startup or navigation. This can happen when the values passed in `render(...)` do not match the expected page parameter types or when the signed-in user does not have access to the configured home page.
82+
83+
To configure an error page, open the Embedded profile in the **Navigation** editor and select the page you want to use.
84+
7785
## Setting a Nanoflow as a Home Page {#nanoflow-home-page}
7886

7987
Instead of using a page, you can set a nanoflow as your app's home page as long as you are using a native profile. The nanoflow you selected will be executed during startup and will show your app's starting page. This is a normal nanoflow call, which means that you can implement custom logic that determines which page to show, creates objects, calls sub-nanoflows, uses JavaScript actions, and more.
@@ -134,3 +142,4 @@ To avoid adding the menu widget on every page in your app, you can use a layout.
134142

135143
* [Atlas UI](/howto/front-end/atlas-ui/)
136144
* [Create Your First Two Overview and Detail Pages](/howto/front-end/create-your-first-two-overview-and-detail-pages/)
145+
* [Embedding the Client](/refguide/mendix-client/embedding-the-client/)

0 commit comments

Comments
 (0)