Document embedded client public Beta#11204
Open
WimJongeneel wants to merge 20 commits into
Open
Conversation
WimJongeneel
force-pushed
the
docs/embedding-the-client
branch
2 times, most recently
from
7d6c99e to
bc6cf73
Compare
WimJongeneel
force-pushed
the
docs/embedding-the-client
branch
from
e8fc6fc to
5e4dc15
Compare
ancajuravle
reviewed
Jun 16, 2026
WimJongeneel
changed the title
Contributor
Author
|
@MarkvanMents this one is ready to be reviewed. |
Collaborator
Thanks - I'll pick it up tomorrow. |
jdiehl
approved these changes
Jun 19, 2026
jdiehl
left a comment
jdiehl
left a comment
Contributor
There was a problem hiding this comment.
Great job on the docs, very thorough and understandable. I added some minor comments
|
|
||
| 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. | ||
|
|
||
| The Embedded profile defines a default home page and can also define an fallbacl 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/). |
|
|
||
| ## Introduction | ||
|
|
||
| The embedded client lets you use a Mendix web app as a component inside another web application, without using the standard Mendix shell page. This makes it easier to add Mendix capabilities to broader digital experiences, support micro-frontend architectures, and integrate Mendix seamlessly with existing portals, products, or custom frontends. In this setup, the host application owns the surrounding page and browser-level experience, while the Mendix app owns the region where it is mounted. |
Contributor
There was a problem hiding this comment.
Remove "without using the standard Mendix shell page"
| * Passes page parameters to the embedded home page | ||
| * Calls `render(...)` with the container element | ||
| * Returns the unmount function from the embedded client | ||
|
|
Contributor
There was a problem hiding this comment.
Can you make your examples repository public and add a link here?
Contributor
Author
There was a problem hiding this comment.
Yes, I've put it on the Mendix GitHub and added a new section linking to it: https://github.com/mendix/embedded-mendix-demo-apps
| An embedded app does not react to changes in the browser address bar or to the browser's back and forward buttons. This is because the embedded app runs as a component inside the host app, and the host app should control browser navigation. | ||
|
|
||
| The embedded Mendix app can still navigate internally. For example, it can open other pages by using [Show Page](/refguide/show-page/) actions or buttons that open a page. | ||
|
|
Contributor
There was a problem hiding this comment.
Explain what happens when the browser is refreshed - I am assuming the homepage is shown?
Contributor
Author
There was a problem hiding this comment.
Yes, that is correct
|
|
||
| ### Optional Parameters | ||
| Omitting a parameter that is marked as optional from the `parameters` object will result in the fallback page being shown instead of the default value being passed. | ||
|
|
Contributor
There was a problem hiding this comment.
Can you add that cross-site cookies must be enabled by the browser (if this is indeed the case)?
Contributor
Author
There was a problem hiding this comment.
Yes, that depends on the setup, I've added a new section documenting it
This was referenced Jun 19, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.