This document is a plugin development guide for developers.
Required Prerequisites
• CLI (Command-Line Interface)
• npm (node package manager)
• npx (node package execute)
• React based on typescript
• Python (depending on the library)
IDEs(recommended) and framework
• NodeJs
Libraries
MIDAS IT provides various libraries to simplify plugin development.
1. Template - @midasit-dev/cra-template-moaui - npm
Plugin Development Template composed of React, TypeScript, moaui, Pyscript*.
2. Template excluding pyscript: @midasit-dev/cra-template-moaui-light - npm
Plugin Development Template composed of React, TypeScript, moaui.
3. Components: @midasit-dev/moaui-components-v1 - npm
UI Components applying MIDAS IT's design based on Material UI.
StoryBook: @midasit-dev/moaui-lab
*Why Pyscript?
As an engineering tool, the plugin inherently requires mathematical calculations. And Python is considered the optimal tool for performing such engineering calculations. Therefore, it has been incorporated.
Upload Plug-in
The developed plug-in can be registered and used within the product. The process is as follows.
Now, when your run the uploaded plug-in (make sure to verify the API connection beforehand), you will see the developed interface displayed as intended.
FAQ
Q: How to register an Icon?
A: The plugin recognizes the "icon.svg" file located at the top level of the build folder and displays it as the icon (other formats are not supported). Therefore, create the SVG file, save it as "icon.svg", and ensure it is included when packaging the build into a ZIP file.
Q: How to edit the Description?
A: The content of the readme.md file in the build folder is displayed as the plug-in description. Therefore, please write the description in the readme.md file and ensure it is included when creating the build.
Q: How to share the plug-in with other users?
A: We are planning to develop a system for sharing individually developed plug-ins on a marketplace.