Skip to content

Update docs for including assets directories of widgets in the app bundle #11342

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
EnasAbdelrazek wants to merge 1 commit into
base: development
Choose a base branch
from
Open

Update docs for including assets directories of widgets in the app bundle #11342

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 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 @@ -68,7 +68,8 @@ A widget package file is just a ZIP archive containing the following things:
* *{widgetName}.tile.png* sets the tile image inside the Studio Pro toolbox in tile view (the ideal image size is 256x192 pixels, but other sizes will be resized to fit)
* *{widgetName}.tile.dark.png* sets the dark-mode equivalent to *{widgetName}.tile.png*
* Optionally, some widget-related resources, preferably located next to the file which contains the client component
* Note that all CSS files you add (except the one located in the **lib** sub-directory) will automatically be loaded in an app via the widget
* All CSS files you add (except the one located in the **lib** sub-directory) will automatically be loaded in an app via the widget.

@WimJongeneel WimJongeneel Jun 12, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"except the one", should this be "except the ones"? Or will there ever by only one in the lib folder?

* When the React Client is enabled for an app, any `assets` directories in a widget package are automatically copied to the widget's directory under `dist` during bundling. This ensures that all asset files from a pluggable widget are included in the final build and available at runtime.

@WimJongeneel WimJongeneel Jun 12, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"any assets directories", does this mean that this also works for assets folders in subdirectories?

* Optionally, a *locales* folder.

Naming your widget package file after the `widgetName` is best practice. Also, a widget package can include multiple widgets by putting several of the above items in the same widget package. However, creating such packages is *not recommended*.
Expand Down
3 changes: 2 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 @@ -69,7 +69,8 @@ A widget package file is just a ZIP archive containing the following things:
* *{widgetName}.tile.png* sets the tile image inside the Studio Pro toolbox in tile view (the ideal image size is 256x192 pixels, but other sizes will be resized to fit)
* *{widgetName}.tile.dark.png* sets the dark-mode equivalent to *{widgetName}.tile.png*
* Optionally, some widget-related resources, preferably located next to the file which contains the client component
* Note that all CSS files you add (except the one located in the **lib** sub-directory) will automatically be loaded in an app via the widget
* All CSS files you add (except the one located in the **lib** sub-directory) will automatically be loaded in an app via the widget.
* When the React Client is enabled for an app, any `assets` directories in a widget package are automatically copied to the widget's directory under `dist` during bundling. This ensures that all asset files from a pluggable widget are included in the final build and available at runtime.

Naming your widget package file after the `widgetName` is best practice. Also, a widget package can include multiple widgets by putting several of the above items in the same widget package. However, creating such packages is *not recommended*.

Expand Down
Loading