Skip to content

Commit eadfeb7

Browse files
committed
Add premium feature details and new visuals for "Project Banner" and other customization options. Update documentation with structured content and relevant links.
1 parent f51fafc commit eadfeb7

17 files changed

Lines changed: 122 additions & 18 deletions

docs/configuration/accent-mode.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ next:
1717
Accent Mode allows you to emphasize specific UI components by applying the accent color more prominently throughout the IDE.
1818
{:class='title'}
1919

20-
This feature is only available for premium users.
20+
This feature is only available for premium users. You can either buy a premium license for the plugin, or purchase the license for this feature only by going to this link: [Material Theme Extras](https://plugins.jetbrains.com/plugin/19250-material-theme-ui-extras).
2121
{:class='card-panel warn'}
2222

2323
{% include carbonads.html %}

docs/configuration/component-settings.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,15 @@ These settings provide you with a wide range of customization options for variou
1919

2020
{% include carbonads.html %}
2121

22-
{% include figure.html content="/screens/settingsv3/uiComponents.png" caption="UI Components" %}
23-
24-
Some features are only available for premium users.
22+
Some features are only available for premium users. You can either buy a premium license for the plugin, or purchase the license for these features only by going to this link: [Material Theme Extras](https://plugins.jetbrains.com/plugin/19250-material-theme-ui-extras).
2523
{:class='card-panel warn'}
2624

25+
----
26+
2727
## Look And Feel
2828

29+
{% include figure.html content="/screens/settingsv3/uiComponents.png" caption="UI Components" %}
30+
2931
### Material Design Style
3032

3133
This feature is available in the free plan.

docs/configuration/contrast.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ Contrast settings allow you to improve the visibility of UI components by adding
1919

2020
{% include carbonads.html %}
2121

22+
The High Contrast feature is only available for premium users. You can either buy a premium license for the plugin, or purchase the license for this feature only by going to this link: [Material Theme High Contrast](https://plugins.jetbrains.com/plugin/17456-material-theme-ui-high-contrast).
23+
{:class='card-panel warn'}
24+
2225
## Contrast Settings
2326

2427
You can configure the contrast settings by navigating to `Settings → Appearance → Material Theme UI → Contrast`.

docs/configuration/features-settings.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,14 @@ wallpapers:
2424
alttext: Material Darker
2525
---
2626

27-
Some of these features are only available for premium users.
28-
{:class='card-panel warn'}
29-
3027
Here you can turn on and off specific features of the Material Theme for even further customization.
3128
{:class='title'}
3229

3330
{% include carbonads.html %}
3431

32+
Some features are only available for premium users. You can either buy a premium license for the plugin, or purchase the license for these features only by going to this link: [Material Theme Extras](https://plugins.jetbrains.com/plugin/19250-material-theme-ui-extras).
33+
{:class='card-panel warn'}
34+
3535
## General
3636

3737
### Animated Tool Windows

docs/configuration/project-frame-settings.md

Lines changed: 102 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@ next:
1414
title: Other Tweaks
1515
---
1616

17-
This feature is only available for premium users.
18-
{:class='card-panel warn'}
19-
2017
This panel controls settings related to the **Project Title Bar** and the **Project Banner** feature.
2118
{:class='title'}
2219

2320
{% include carbonads.html %}
2421

22+
This feature is only available for premium users. You can either buy a premium license for the plugin, or purchase the license for this feature only by going to this link: [Material Theme Project Frame](https://plugins.jetbrains.com/plugin/19310-material-theme-ui-project-frame).
23+
{:class='card-panel warn'}
24+
2525
## Application Frame
2626

2727
Introduced in the New UI (2023), JetBrains IDEs feature a thick, colorful application frame that encompasses the editor and tool windows. This frame contains action buttons, widgets, and other supplementary elements.
@@ -52,7 +52,7 @@ You can customize which parts of the application frame to colorize. While only t
5252

5353
## Project Widget Settings
5454

55-
This section expose some configuration settings for the native **Project Gradient** feature.
55+
This section exposes some configuration settings for the native **Project Gradient** feature.
5656

5757
### Gradient Radius
5858

@@ -66,4 +66,101 @@ This setting allows you to specify the radius of the gradient. It's 2000px by de
6666

6767
{% include figure.html content="/screens/projectFrame/4000gradient.png" caption="Gradient Radius: 4000px" %}
6868

69-
</div>
69+
</div>
70+
71+
----
72+
73+
## Project Banner
74+
75+
The **Project Banner** is a feature that allows you to display a customizable colored banner at the top of the IDE. This banner can be used to provide useful information about the current file, project, or module.
76+
77+
The color of the banner uses the same color of the application frame, e.g. generated from the project name.
78+
79+
{% include figure.html content="/screens/projectFrame/projectBanners.png" caption="Project Banner" %}
80+
81+
This banner can display a variety of information, such as:
82+
- the current opened file
83+
- the path of the current file
84+
- the current project name
85+
- the current module name
86+
- the current opened file icon
87+
88+
### Show Project Icon
89+
90+
This setting determines whether to display the project icon in the banner.
91+
92+
{% include figure.html content="/screens/projectFrame/withoutIcon.png" caption="Banner without Project Icon" %}
93+
94+
### Show Project Text
95+
96+
This setting determines whether to display the text in the banner.
97+
98+
{% include figure.html content="/screens/projectFrame/withoutText.png" caption="Banner without Project Text" %}
99+
100+
### Customize Text
101+
102+
Here you can customize the text that appears in the banner. You can use the following variables to include dynamic information:
103+
- `{project}`: The name of the current project.
104+
- `{subProject}`: When you have multiple projects in the same workspace, the project name of the currently opened file.
105+
- `{module}`: The name of the current module (for Java and Kotlin projects).
106+
- `{file}`: The name of the currently opened file.
107+
- `{fileIcon}`: The icon of the currently opened file.
108+
- `{path}`: The path of the currently opened file, relative to the project root.
109+
- `{fullPath}`: The full path of the currently opened file.
110+
111+
{% include figure.html content="/screens/projectFrame/customizedText.png" caption="Banner with Customized Text" %}
112+
113+
----
114+
115+
## Project Banner Widget
116+
117+
In addition to the Project Banner, the plugin also provides a **Project Banner Widget** that can be added to the Title Bar, showing the same information as the Project Banner. This way, you can benefit from the Project Banner's features without having to add the banner to the Title Bar.
118+
119+
{% include figure.html content="/screens/projectFrame/projectBannerWidget.png" caption="Project Banner Widget" %}
120+
121+
To add it, rather than using this settings page, you need to right click on the Title Bar and select **Customize Toolbar**. Then, search for the **Material Project Title Bar Widget** and click **Add**.
122+
123+
**Note**: This widget is added by default, so this is also relevant if you want to remove it.
124+
{:class='card-panel info'}
125+
126+
In addition to showing the information, this widget also provides you with the option to select from a list of predefined presets, enabling you to customize it to your needs.
127+
128+
{% include figure.html content="/screens/projectFrame/presets.png" caption="Project Banner Widget Presets" %}
129+
130+
----
131+
132+
## Project Banner Settings
133+
134+
The following settings allow you to customize the appearance of the Project Banner Widget.
135+
136+
### Project Banner Width
137+
138+
Specify a custom width for the Project Banner Widget. Setting it to 0 will take the full width of the IDE.
139+
140+
The default value is 800.
141+
142+
{% include figure.html content="/screens/projectFrame/customWidth.png" caption="Custom Project Banner Width" %}
143+
144+
### Project Banner Height
145+
146+
Specify a custom height for the Project Banner Widget.
147+
148+
The default value is 30.
149+
150+
{% include figure.html content="/screens/projectFrame/customHeight.png" caption="Custom Project Banner Height" %}
151+
152+
### Project Banner Font Family and Font Size
153+
154+
This gives you the option to customize the font family and font size of the Project Banner Widget.
155+
156+
{% include figure.html content="/screens/projectFrame/customFont.png" caption="Custom Project Banner Font" %}
157+
158+
----
159+
160+
## Per-project settings
161+
162+
Just like the Tabs Settings or the Trees Settings, the Project Banner Settings can also be configured per-project.
163+
164+
This way, you can decide to change the color of the banner for each project individually, use a custom text, a different font, etc.
165+
166+
{% include figure.html content="/screens/projectFrame/customProjectSettings.png" caption="Per-project Project Banner Settings" %}

docs/configuration/tab-settings.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,16 @@ next:
1414
title: Spacing Settings
1515
---
1616

17-
Some features are only available for premium users.
18-
{:class='card-panel warn'}
19-
2017
These settings allow you to customize the appearance of the Tabs, whether it's Editor Tabs, Debugger Tabs, or any tabbed pane in the IDE. You can customize the height, the active tab indicator, the font, and much more to achieve the perfect look for your IDE.
2118
{:class='title'}
2219

2320
{% include carbonads.html %}
2421

22+
Some features are only available for premium users. You can either buy a premium license for the plugin, or purchase the license for these features only by going to this link: [Material Theme Extras](https://plugins.jetbrains.com/plugin/19250-material-theme-ui-extras).
23+
{:class='card-panel warn'}
24+
25+
----
26+
2527
## Tab Customization
2628

2729
{% include figure.html content="/screens/settingsv3/tabSettings.png" caption="Tab Settings Overview" %}

docs/configuration/trees-settings.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@ These settings allow you to customize the look and feel of the IDE's tree views,
2020

2121
{% include carbonads.html %}
2222

23-
----
24-
25-
Some features are only available for premium users.
23+
Some features are only available for premium users. You can either buy a premium license for the plugin, or purchase the license for these features only by going to this link: [Material Theme Extras](https://plugins.jetbrains.com/plugin/19250-material-theme-ui-extras).
2624
{:class='card-panel warn'}
2725

26+
----
27+
2828
Trees Settings are grouped into the following categories:
2929
- [Spacing Settings](#spacing-settings)
3030
- [Font Settings](#font-settings)
14.4 KB
Loading
12.7 KB
Loading
983 KB
Loading

0 commit comments

Comments
 (0)