Skip to content

Changed Client API docs structure #9638

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: development
Choose a base branch
from
Open

Changed Client API docs structure #9638

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a41a63e
Moved Client API page into separate Studio Pro versions directories
exec-astraea Jun 5, 2025
4412cd2
Mention deprecation and removal of the legacy client API
exec-astraea Jun 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions ...docs-mxsdk/apidocs/frontend/client-api.md → ...mxsdk/apidocs/studio-pro-10/client-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Use our powerful APIs to build any JavaScript action you need.

## Client API

The Client API is compatible with both the React and the Dojo client.
The client API is compatible with both the React and the Dojo client and will replace the previous API which was based on the global mx object.

* [Mendix 10 Client API](https://apidocs.rnd.mendix.com/10/client-mx-api/index.html)

Expand All @@ -23,9 +23,9 @@ The Mendix 10 Client API is available in Studio Pro 10.20.0 and above. For earli
The Client API is not supported in widgets. For widget development, please use our [Pluggable Widgets API](/apidocs-mxsdk/apidocs/pluggable-widgets/)
{{% /alert %}}

## Legacy Client APIs {#legacy}
## Legacy Client API {#legacy}

* [Mendix 10 React Client API](https://apidocs.rnd.mendix.com/10/client-react/index.html)
* [Mendix 10 Dojo Client API](https://apidocs.rnd.mendix.com/10/client/index.html)
* [Mendix 9 Dojo Client API](https://apidocs.rnd.mendix.com/9/client/index.html)
* [Mendix 8 Dojo Client API](https://apidocs.rnd.mendix.com/8/client/index.html)
This API is deprecated in Mendix 11 and will be fully removed in Mendix 12.

* [Mendix 10 Client API (React)](https://apidocs.rnd.mendix.com/10/client-react/index.html)
* [Mendix 10 Client API (Dojo)](https://apidocs.rnd.mendix.com/10/client/index.html)
20 changes: 20 additions & 0 deletions content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/client-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: "Client API"
url: /apidocs-mxsdk/apidocs/client-api-11/
description: "This API enriches the user interface of your applications by building on top of the Mendix web Client APIs."
weight: 30
---

## Introduction

Use our powerful APIs to build any JavaScript action you need.

## Client API

The client API is compatible with both the React and the Dojo client.

* [Mendix 11 Client API](https://apidocs.rnd.mendix.com/11/client-mx-api/index.html)

{{% alert color="warning" %}}
The Client API is not supported in widgets. For widget development, please use our [Pluggable Widgets API](/apidocs-mxsdk/apidocs/pluggable-widgets/)
{{% /alert %}}
14 changes: 14 additions & 0 deletions content/en/docs/apidocs-mxsdk/apidocs/studio-pro-9/client-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: "Client API"
url: /apidocs-mxsdk/apidocs/client-api-9/
description: "This API enriches the user interface of your applications by building on top of the Mendix web Client APIs."
weight: 30
---

## Introduction

Use our powerful APIs to build any JavaScript action you need.

## Client API

* [Mendix 9 Client API](https://apidocs.rnd.mendix.com/9/client/index.html)