Create Custom Pluggable Widget

Generate Mendix pluggable widget boilerplate with React and TypeScript.

1|Updated Jun 5, 2026
One-click install
npx skills add https://github.com/engalar/mxcli-taskdemo --skill create-custom-pluggable-widget
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Create Custom Pluggable Widget
Source: https://github.com/engalar/mxcli-taskdemo/tree/main/TaskDemo/.claude/skills/create-custom-widget
Command: npx skills add https://github.com/engalar/mxcli-taskdemo --skill create-custom-pluggable-widget

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires @mendix/pluggable-widgets-tools, react, react-dom, classnames.

What problem does it solve?

This skill streamlines the complex process of creating Mendix pluggable widgets by providing a standardized scaffolding workflow, ensuring correct file structures and configuration for React-based components.

Core Features & Use Cases

  • Project Scaffolding: Automatically generates the necessary package.json, tsconfig, and XML definitions for a new widget.
  • Property Mapping: Provides a clear reference for mapping Mendix widget properties to React component props, including support for attributes, actions, and data sources.
  • Build & Integration: Includes instructions for building the .mpk package and deploying it directly into a Mendix project.

Quick Start

Use the create custom pluggable widget skill to scaffold a new widget named ProgressRing in the current directory.

Frequently Asked Questions about Create Custom Pluggable Widget

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a custom Mendix pluggable widget using React and TypeScript?

To create a custom Mendix pluggable widget, you need to scaffold the project structure with package.json, tsconfig, and XML definitions, then map Mendix properties to React component props and build the final .mpk package for Studio Pro.

What is the process for mapping Mendix widget properties to React component props?

Mendix widget properties are mapped to React component props through XML property definitions, ensuring correct type mapping for attributes, actions, and data sources within the pluggable widget configuration.

Do I need React and TypeScript to build Mendix pluggable widgets?

Yes, React and TypeScript are required dependencies for building Mendix pluggable widgets, along with @mendix/pluggable-widgets-tools and react-dom for scaffolding and rendering the custom UI components.

How do I build and deploy a Mendix pluggable widget into Studio Pro?

To deploy a Mendix pluggable widget, you build the project to generate an .mpk package using the pluggable-widgets-tools, then integrate that package directly into your Mendix Studio Pro project.

What's the best way to scaffold a new Mendix pluggable widget project?

The best way to scaffold a Mendix pluggable widget project is to use a standardized workflow that automatically generates the necessary package.json, tsconfig, and XML widget definition files for your custom UI component.

Can I use classnames with Mendix pluggable widgets for React styling?

Yes, the classnames library is included as a dependency for Mendix pluggable widgets, allowing you to conditionally join CSS class names when styling your React-based UI components.