Skip to content

Commit 816b910

Browse files
committed
Merge branch 'development' into nk-test-docsy-npm
2 parents c64d3a6 + f3669a4 commit 816b910

40 files changed

Lines changed: 21553 additions & 548 deletions

File tree

content/en/docs/apidocs-mxsdk/apidocs/pluggable-widgets/_index.md

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,20 @@
22
title: "Pluggable Widgets API"
33
url: /apidocs-mxsdk/apidocs/pluggable-widgets/
44
category: "API Documentation"
5-
description: "This API helps you to understand pluggable widgets, how they extend app functionality, and how they can be built to interact with Mendix's APIs."
5+
description: "This API helps you to understand pluggable widgets, how they extend app functionality, and how they can be built to interact with Mendix's APIs in Mx10."
6+
no_list: false
7+
description_list: true
68
weight: 80
79
tags: ["Widget", "Pluggable", "Custom", "JavaScript", "React"]
8-
aliases:
9-
- /apidocs-mxsdk/apidocs/pluggable-parent-9
1010
---
1111

1212
## 1 Introduction
1313

14-
Mendix comes with a wide variety of [Widgets](/refguide/pages/#widgets-categories), but sometimes your app requires a widget outside of this set. To support a more advanced UI pattern or create app-specific interactions, you will need to make your own pluggable widget. Your new pluggable widget can be used while modeling pages alongside standard Mendix components. It can also be shared between multiple apps and distributed through the [Marketplace](/appstore/).
14+
Mendix comes with a wide variety of [Widgets](/refguide/pages/#widgets-categories), but sometimes your app requires a widget outside of this set. To support a more advanced UI pattern or create app-specific interactions, you will need to make your own pluggable widget. This documentation will help you achieve that in Studio Pro 10. See these links for other versions' documentation:
15+
* [Mendix 9](/apidocs-mxsdk/apidocs/pluggable-parent-9/)
16+
* [Mendix 8](/apidocs-mxsdk/apidocs/pluggable-parent-8/)
17+
18+
Your new pluggable widget can be used while modeling pages alongside standard Mendix components. It can also be shared between multiple apps and distributed through the [Marketplace](/appstore/).
1519

1620
You are in control of a pluggable widget's appearance and behavior. Customize a pluggable widget by implementing a widget as a plain [React](https://reactjs.org/) component written in JavaScript or TypeScript. The component will be rendered in a Mendix app, and will be able to use APIs provided by Mendix to interact with that app.
1721

@@ -155,10 +159,6 @@ For more complex help pages you can link to a markdown page. For security reason
155159

156160
#### 4.2.2 Toolbox Category {#toolbox-category}
157161

158-
{{% alert color="info" %}}
159-
This feature was introduced in Mendix Studio Pro v9.4.
160-
{{% /alert %}}
161-
162162
To provide more clarity for Studio Pro users you can specify a toolbox category for your widgets. When provided, it determines a toolbox category for a widget in Studio Pro. It is possible to specify existing built-in categories such as **Data** or **Input** as well as new arbitrary categories like **Maps**.
163163

164164
When an existing category is specified, then your widget is placed in it next to existing built-in widgets. When a new category is specified, then your widget placed in that new category.
@@ -291,11 +291,4 @@ Here is how a caption and description look in Studio Pro:
291291

292292
{{< figure src="/attachments/apidocs-mxsdk/apidocs/pluggable-widgets/card-description.png" alt="description" >}}
293293

294-
## 7 Read More
295-
296-
* [Client APIs Available to Pluggable Widgets](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/)
297-
* [Declaring Native Dependencies for Pluggable Widgets](/apidocs-mxsdk/apidocs/pluggable-widgets-native-dependencies/)
298-
* [Pluggable Widget Property Types](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types/)
299-
* [Preview Appearance APIs for Pluggable Widgets](/apidocs-mxsdk/apidocs/pluggable-widgets-studio-apis/)
300-
* [Configuration Module API for Pluggable Widgets](/apidocs-mxsdk/apidocs/pluggable-widgets-config-api/)
301-
* Pluggable Widget API information for [Mendix 8](/apidocs-mxsdk/apidocs/pluggable-parent-8/)
294+
## 7 Documents in this Section
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
title: "Mendix 8"
33
url: /apidocs-mxsdk/apidocs/pluggable-parent-8/
4-
weight: 100
5-
description: Information on Pluggable Widget API.
4+
weight: 60
5+
description: Information on Pluggable Widget API in Mx8.
66
tags: ["API", "pluggable","widget"]
77
---
88

99
The following Mendix 8 pluggable widget API documents are available here:
1010

11-
* [Client APIs Available to Pluggable Widgets](/apidocs-mxsdk/apidocs/client-apis-for-pluggable-widgets-8/) for Mendix 8
1211
* [Pluggable Widget Property Types](/apidocs-mxsdk/apidocs/property-types-pluggable-widgets-8/) for Mendix 8
12+
* [Client APIs Available to Pluggable Widgets](/apidocs-mxsdk/apidocs/client-apis-for-pluggable-widgets-8/) for Mendix 8
1313
* [Preview Appearance APIs for Pluggable Widgets](/apidocs-mxsdk/apidocs/studio-apis-for-pluggable-widgets-8/) for Mendix 8
14-
* [Differences Between Pluggable and Custom Widgets](/apidocs-mxsdk/apidocs/differences-between-pluggable-and-custom-widgets/)
14+
* [Compare Pluggable and Custom Widgets](/apidocs-mxsdk/apidocs/differences-between-pluggable-and-custom-widgets/) for Mendix 8

content/en/docs/apidocs-mxsdk/apidocs/pluggable-widgets/pluggable-parent-8/client-apis-for-pluggable-widgets-8.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: "Client APIs Available to Pluggable Widgets"
2+
title: "Client APIs – Mx8"
33
linktitle: "Client APIs for Pluggable Widgets"
44
url: /apidocs-mxsdk/apidocs/client-apis-for-pluggable-widgets-8/
5-
weight: 10
5+
weight: 20
66
description: A guide for understanding the client APIs available to pluggable widgets.
77
tags: ["Widget", "Pluggable", "JavaScript"]
88
---

content/en/docs/apidocs-mxsdk/apidocs/pluggable-widgets/pluggable-parent-8/differences-between-pluggable-and-custom-widgets.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Differences Between Pluggable and Custom Widgets"
2+
title: "Compare Pluggable and Custom Widgets – Mx8"
33
linktitle: "Compare Pluggable and Custom Widgets"
44
url: /apidocs-mxsdk/apidocs/differences-between-pluggable-and-custom-widgets/
55
description: This document explains the differences between pluggable and custom widgets.

content/en/docs/apidocs-mxsdk/apidocs/pluggable-widgets/pluggable-parent-8/property-types-pluggable-widgets-8.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: "Pluggable Widget Property Types"
2+
title: "Property Types – Mx8"
33
url: /apidocs-mxsdk/apidocs/property-types-pluggable-widgets-8/
4-
weight: 20
4+
weight: 10
55
description: A guide for understanding pluggable widgets' property types.
66
tags: ["Widget", "Pluggable", "Custom", "JavaScript", "React"]
77
---

content/en/docs/apidocs-mxsdk/apidocs/pluggable-widgets/pluggable-parent-8/studio-apis-for-pluggable-widgets-8.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Preview Appearance APIs for Pluggable Widgets"
2+
title: "Preview Appearance APIs – Mx8"
33
linktitle: "Preview Appearance APIs"
44
url: /apidocs-mxsdk/apidocs/studio-apis-for-pluggable-widgets-8/
55
weight: 30
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: "Mendix 9"
3+
url: /apidocs-mxsdk/apidocs/pluggable-parent-9/
4+
weight: 50
5+
description: Information on the Pluggable Widget API in Mx9.
6+
tags: ["API", "pluggable","widget"]
7+
---
8+
9+
The following Mendix 9 pluggable widget API documents are available here:
10+
11+
* [Pluggable Widget Property Types](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types-9/) for Mendix 9
12+
* [Client APIs Available to Pluggable Widgets](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis-9/) for Mendix 9
13+
* [Preview Appearance APIs for Pluggable Widgets](/apidocs-mxsdk/apidocs/pluggable-widgets-studio-apis-9/) for Mendix 9
14+
* [Configuration Module API for Pluggable Widgets](/apidocs-mxsdk/apidocs/pluggable-widgets-config-api-9/) for Mendix 9
15+
* [Declaring Native Dependencies](/apidocs-mxsdk/apidocs/pluggable-widgets-native-dependencies-9/) for Mendix 9

0 commit comments

Comments
 (0)