This is the Mendix client API documentation.

This documentation is primarily meant to assist the development of custom client side extensions (widgets and third party integration code, for the most part).


The Mendix client uses the Dojo library as a basis, in particular the Dijit library which provides the widget infrastructure.

Basic styling is provided by the Twitter Bootstrap CSS framework.


The client consists of a number of subsystems and some object classes that implement the concepts used by these subsystems. All subsystems exist inside a single object, mx, while the object classes are divided between the mxui and mendix namespaces.

You can load the client with some lines similar to the following in your HTML file:

<link rel="stylesheet" href="path/to/mxui/ui/mxui.css">

    dojoConfig = {
        baseUrl: "path/to/dojo/"
<script src="path/to/mxui/mxui.js"></script>

This starts the client and tries to log into the system.