Web widgets

The repository of platform-supported widgets and modules for Mendix.

For issues and bugs related to CSS, Widgets, Atlas, JS Actions, or this repository, please contact Mendix Support

Prerequisites

• version of Node.js

• version of pnpm

Development

1. Clone the repo.

$ git clone https://github.com/mendix/web-widgets.git

2. Install the dependencies.

$ cd web-widgets
$ pnpm install

3. Go to the widget (package) you want to work on, set MX_PROJECT_PATH, and run pnpm start.

$ cd packages/pluggableWidgets/datagrid-web/

# Mac and Linux:
$ export MX_PROJECT_PATH="$HOME/Documents/Mendix/DataBoardApp"

# For Windows (PowerShell):
# $env:MX_PROJECT_PATH = 'C:\Users\Tom\Documents\Mendix\DataBoardApp'

$ pnpm start

4. Go to Mendix Studio Pro and run App>Synchronize App Directory to update the widget code in the project. If your app is already running, restart it.

5. Keep code clean: run pnpm test and pnpm lint.

$ pnpm lint
...
$ pnpm test

Note: run pnpm test --watch to start unit tests in watch mode.

Contributing

See CONTRIBUTING.md.

Raising problems/issues

• We encourage everyone to open a support ticket through Mendix Support in case of problems with widgets or scaffolding tools (Pluggable Widgets Generator or Pluggable Widgets Tools).