Skip to content

Change Pluggable Widgets API tag description #11832

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

Merged
ConnorLand merged 5 commits into from
Aug 31, 2026
Merged

Change Pluggable Widgets API tag description #11832

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
04deb0d
change tag
ConnorLand Aug 28, 2026
f6097d1
Update _index.md
ConnorLand Aug 31, 2026
ec3a2c0
Update _index.md
ConnorLand Aug 31, 2026
6b20d89
Update _index.md
ConnorLand Aug 31, 2026
48eb42c
Update _index.md
ConnorLand Aug 31, 2026
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
4 changes: 3 additions & 1 deletion content/en/docs/apidocs-mxsdk/apidocs/studio-pro-10/pluggable-widgets/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,8 @@ Both `packageName` and `packageVersion` should be aligned with the app's informa

The widget definition XML file is an essential part of a widget because it describes that widget's basic information and capabilities, such as if that widget can function offline. This file also contains a defined list of properties configurable in the widget. If you use the Mendix Pluggable Widget Generator, the contents of this file will be scaffolded for you.

A schema for the widget definition file is made available through the [Mendix package](https://www.npmjs.com/package/mendix) which is installed by the `pluggable-widgets-tools` package. Editor plugins and IDE's can use the schema to provide in-line feedback while authoring the definition file.

A simple widget XML file might look like this:

```xml
Expand Down Expand Up @@ -173,7 +175,7 @@ You can provide additional help information to widget users by using a help page

{{< figure src="/attachments/apidocs-mxsdk/apidocs/pluggable-widgets/widget-dialog-help-button.png" alt="basic widget" class="no-border" >}}

A URL of a help page can be provided through the `helpUrl` property after the `description` tag:
A URL of a help page can be provided through the `helpUrl` property after the `studioProCategory` tag:

```xml
<helpUrl>https://marketplace.mendix.com/link/component/105695/</helpUrl>
Expand Down
4 changes: 3 additions & 1 deletion content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/pluggable-widgets/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,8 @@ Both `packageName` and `packageVersion` should be aligned with the app's informa

The widget definition XML file is an essential part of a widget because it describes that widget's basic information and capabilities, such as if that widget can function offline. This file also contains a defined list of properties configurable in the widget. If you use the Mendix Pluggable Widget Generator, the contents of this file will be scaffolded for you.

A schema for the widget definition file is made available through the [Mendix package](https://www.npmjs.com/package/mendix) which is installed by the `pluggable-widgets-tools` package. Editor plugins and IDE's can use the schema to provide in-line feedback while authoring the definition file.

A simple widget XML file might look like this:

```xml
Expand Down Expand Up @@ -173,7 +175,7 @@ You can provide additional help information to widget users by using a help page

{{< figure src="/attachments/apidocs-mxsdk/apidocs/pluggable-widgets/widget-dialog-help-button.png" alt="basic widget" class="no-border" >}}

A URL of a help page can be provided through the `helpUrl` property after the `description` tag:
A URL of a help page can be provided through the `helpUrl` property after the `studioProCategory` tag:

```xml
<helpUrl>https://marketplace.mendix.com/link/component/105695/</helpUrl>
Expand Down