Contents of the HTML
Plug-In Project Template
Once you create a
template project for your HTML plug-in, you must be familiar with the folder
structure of the project and the purpose of each file inside the project. This
knowledge will help you to easily create your custom plug-ins for the
vSphere Client
.
The following tables contain
detailed information about the structure of the UI and Java service components
of the HTML plug-in project template.
UI Project
Template Structure
- myplugin-id/src/
- app/
- Main source files for the plug-in user interface, including Javascript and Typescript files.
- assets/
- css/
- CSS files used in the plug-in. Thecssfolder contains theplugin-icons.cssfile that you can use to define the external icons.
- i18n/
- Localized resources used in the plug-in.
- images/
- Default images used in the plug-in.
- images-dark/
- I:mages applied when the dark theme is active.
- main/locales/
- String resources specific to different locales.
- main/webapp/
- plugin.xml
- Manifest file of the plug-in. Defines extensions and resources.
- META-INF/
- MANIFEST.MF
- Manifest file of the WAR bundle.
- WEB-INF/spring/
- Spring configuration.
- bundle-context.xml
- Declares the service that this UI bundle uses.
Java Service Project Template
Structure
- myplugin-service/
- build-java.bat
- Windows script to generate the Java service bundle.
- build-java.sh
- MacOS script to generate the Java service bundle.
- build-java.xml
- antscript to generate the Java service bundle.
- src/main/
- resources/META-INF/
- MANIFEST.MF
- The bundle manifest file.
- spring/
- Spring configuration files.
- java/com/mycompany/myplugin/
- services/
- Interfaces and implementations for plug-in services.
- model/
- Data models for plug-in services.
- controllers/
- Controllers for plug-in services.