mirror of
https://github.com/JetBrains/intellij-sdk-code-samples.git
synced 2025-07-30 02:07:50 +08:00
68 lines
3.2 KiB
Markdown
68 lines
3.2 KiB
Markdown
# Theme Structure
|
||
|
||
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
|
||
|
||
<link-summary>Overview of a theme plugin project structure and the most important elements.</link-summary>
|
||
|
||
Themes are components within [IntelliJ Platform plugins](plugin_structure.topic).
|
||
The theme plugins should be stand-alone and not combined with other plugin functionality.
|
||
|
||
> To see a full example theme project, see the [Theme Basics](%gh-sdk-samples%/theme_basics) in IntelliJ SDK Code Samples.
|
||
>
|
||
{style="note"}
|
||
|
||
Themes have several components:
|
||
* A required Theme description (JSON) file in the plugin project's <path>resources</path> folder.
|
||
* A required `themeProvider` declaration in the plugin's <path>[plugin.xml](plugin_configuration_file.md)</path> file, located in the plugin project's <path>META-INF</path> folder.
|
||
* An optional Editor Scheme description (XML) file derived from an exported IDE editor scheme.
|
||
This file is located in the plugin project's <path>resources</path> folder.
|
||
* An optional background image file, located in the plugin project's <path>resources</path> folder.
|
||
* Optional icon image files, located in the plugin project's <path>resources</path> folder.
|
||
|
||
|
||
|
||
## Theme Description File
|
||
|
||
The most important file in every theme project is the theme description file.
|
||
The content of the default file generated with the [Theme wizard](creating_theme_project.md) is a short set of key–value pairs:
|
||
|
||
```json
|
||
{
|
||
"name": "theme_basics",
|
||
"author": "",
|
||
"dark": false,
|
||
"editorScheme": "/theme_basics.xml",
|
||
"ui": {
|
||
}
|
||
}
|
||
```
|
||
|
||
* `name` key matches the first portion of the Theme description <path>$THEME_NAME$.theme.json</path> file name. The value of `name` is displayed in the [Theme](https://www.jetbrains.com/help/idea/settings-appearance.html) <control>Settings</control> dropdown when the theme's plugin is installed in the IDE.
|
||
* `author` - specifies the theme author (empty by default).
|
||
* `dark` - determines the base theme (_Light_ or _Darcula_) that is customized.
|
||
* `editorScheme` - specifies the editor scheme file that describes fonts and colors used in editors (see [](themes_extras.md#adding-a-custom-editor-scheme) for more details).
|
||
* `ui` - allows for overriding the base theme (_Light_ or _Darcula_) properties (see [](themes_customize.md#custom-ui-control-colors) for more details).
|
||
|
||
The wizard also creates a `themeProvider` declaration in the [`<extensions>`](plugin_configuration_file.md#idea-plugin__extensions) section of the plugin's <path>plugin.xml</path> file.
|
||
This declaration binds the theme description file to a theme provider extension using a generated unique `id`.
|
||
|
||
```xml
|
||
<extensions defaultExtensionNs="com.intellij">
|
||
<themeProvider
|
||
id="eb9b7461-397b-4b98-a422-224fc0a74564"
|
||
path="/theme_basics.theme.json"/>
|
||
</extensions>
|
||
```
|
||
|
||
> Do not modify or re-use an existing value of the generated `id` attribute.
|
||
>
|
||
{style="warning"}
|
||
|
||
## Theme Customization
|
||
|
||
The following sections describe the theme customization possibilities in detail:
|
||
* [](themes_customize.md#customizing-icons)
|
||
* [](themes_customize.md#customizing-ui-controls)
|
||
* [](themes_extras.md#adding-a-custom-editor-scheme)
|
||
* [](themes_extras.md#adding-a-custom-background-image)
|