Pluggable Widgets Generator
Yeoman generator for Mendix Pluggable Widgets.
This generator uses the Yeoman scaffolding tool to let you quickly create a Mendix Pluggable Widget.
Install node.js (version >= 10.15).
npm install -g yo
Install Pluggable Widgets Generator:
npm install -g @mendix/generator-widget
Scaffold a widget project
Generate your new project inside an empty folder:
or automatically create the folder using:
yo @mendix/widget MyWidgetName
MyWidgetNamecan consist of space characters as well.
Provide the following information about your widget project (press if you want to skip and use the default values):
- Widget name
- Mendix project path
- Programming language
- Add unit tests
- Add end to end tests
The full widget boilerplate is a fully developed and tested Mendix React widget that shows a value as a badge or a color label (just available for web/responsive platform). It has the following features:
- Display as a badge or a color label
- Attach actions to onClick event
- Set static data text when the dynamic data is not specified
The empty template is a Mendix React hello world widget recommended for more experienced developers.
Add unit tests
Yes is selected, unit tests are included to ensure individual units of the component are tested to determine whether they are fit for use. Default value is
Add end to end tests
Yes is selected, end to end tests are included to ensure that the integrated components of an application function as expected. Default value is
End to end tests apply only to the Full Boilerplate.
End to End is exclusive for web and hybrid mobile apps.
The tool will then create copied files, and run
npm install to install development dependencies.
Using the task runner
The widget generator will include the necessary files and tasks to your package.json for running the tasks over the Pluggable Widgets Tools.
If necessary you can run the tasks using the commands:
npm run build
npm run release
To build and watch for source code changes while developing, run the Mendix project located at the specified
Mendix project pathand run:
If you are running the generator through multiple operating systems (e.g. running a virtualized OS with Parallels on MacOS or any other virtualization software), make sure you have the right privileges and use the same OS for generation and file manipulation.
Issues can be reported on Github.