2.4 KiB
| title |
|---|
| Plugin Icon |
Beginning in version 2018.3, the IntelliJ Platform supports representing a plugin with an icon. A Plugin Icon is intended to be a unique representation of a plugin's functionality, technology, or company.
Plugin Icons are shown in the Settings/Preferences Plugin Manager UI in JetBrains' products. Plugin Icons also appear in the Plugins Repository, and also in MarketPlace.
Note: icons and images that are used within a plugin have different requirements. See Working with Icons and Images for more information.
Plugin Icon File Format
All Plugin Icon images must be provided in SVG format. Plugin Icons will be displayed in 40px by 40px and 80px by 80px size. However, only one size icon should be supplied because the will automatically scale.
| Icon Size | Example SVG Icon |
|---|---|
| 40x40 |  |
Plugin Icon File Naming Convention
Plugin Icon files are named according to the following conventions:
pluginIcon.svgfor use with the default (light) JetBrains IDE themepluginIcon_dark.svgfor use with the Darcula JetBrains IDE theme
Adding Plugin Icons to a Plugin Project
The Plugin Icon files must be in the META-INF folder of the plugin distribution file,
i.e. the *.jar or *.zip file you upload to the plugin repository and install into
a JetBrains IDE.
To include Plugin Icons in your distribution file, place the Plugin Icon files
into a plugin project's resources/META-INF folder. Note this requirement
is the same regardless of using DevKit or Gradle for developing a plugin. For example:
Plugin Icons API
If you need access to existing Plugin Icons you can acquire
them through the Plugin Repository using the following URL format:
https://plugins.jetbrains.com/api/icon?pluginId=${PLUGIN_XMLID}&theme=${DEFAULT|DARCULA}
Note thetheme parameter may be omitted when you are retrieving an icon for a DEFAULT
theme.
An example URL to retrieve the Fortran Plugin Icon would be:
https://plugins.jetbrains.com/api/icon?pluginId=org.jetbrains.fortran&theme=DEFAULT