Skip to content

Commit 508e69f

Browse files
committed
Update "Quick Actions Panel" documentation with new sections, detailed descriptions, and visuals for toggles. Add related images for improved navigation clarity.
1 parent 39ca43f commit 508e69f

27 files changed

Lines changed: 206 additions & 125 deletions

docs/configuration/excluded-files-colors.md

Lines changed: 44 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ toc: true
77
comments: true
88

99
previous:
10-
url: '/docs/configuration/ui-components-settings'
11-
title: Component Settings
10+
url: '/docs/configuration/status-bar-widgets'
11+
title: Status Bar Widgets
1212
next:
1313
url: '/docs/configuration/file-status-colors'
1414
title: File Status Colors
@@ -18,109 +18,95 @@ next:
1818

1919
## Introduction
2020

21-
JetBrains editors are great for all kinds of projects, whatever big they're.
22-
However, once you've started working on big projects, you're beginning to notice that it's getting harder finding your way through open files,
23-
the project tree, or the search results.
21+
JetBrains IDEs are excellent for projects of any scale. However, as projects grow, navigating through open files, the project tree, or search results can become increasingly difficult.
2422

25-
Therefore, the IDEs have a nifty feature called **File Colors**.
26-
It allows developers to add custom colors to specific groups of files according to a pattern.
23+
To address this, JetBrains IDEs offer a feature called **File Colors**. It allows you to assign custom colors to specific groups of files based on patterns.
2724

28-
Such examples are:
25+
Common examples include:
2926

3027
- Excluded Files
3128
- Tests
3229
- Erroneous files
3330
- Build Files
3431
- Logs
35-
- etc...
32+
- etc.
3633

37-
You can even set specific folders representing different parts/modules of your project.
34+
You can even colorize specific folders representing different modules or parts of your project. As a result, files in these categories will have a distinct background color, significantly reducing the time spent searching and navigating through the use of *color-based identification*.
3835

39-
As a result, files belonging to such categories would sport a distinct background color,
40-
significantly reducing the time looking for a file and navigating thanks to *color grepping*.
41-
42-
Such components having this feature are:
36+
This feature is supported in several areas, including:
4337

4438
- Project Tree
4539
- Editor Tabs
46-
- Find in Path Dialog
40+
- Find in Files Dialog
4741
- Search Everywhere dialog
48-
- Navigate to file/class/symbol dialog
49-
- And other places
42+
- Navigate to File/Class/Symbol dialog
43+
- And more
5044

5145
## Configuration
5246

53-
The JetBrains editors come prebundled with at least two _File Colors_:
54-
55-
- **Excluded files**, or files that are _Marked as Excluded_, and therefore excluded for indexing, searching and navigation, resulting in huge performance
56-
boosts.
57-
- Such examples are `node_modules`, `logs`, `vendors`, `gradle` etc…
58-
- **Tests**, which is the test directory in `gradle/rails/symfony`
47+
JetBrains editors come with at least two pre-configured _File Colors_:
5948

60-
**Note**: you can mark a directory for exclusion by clicking right on the directory and select `Mark Directory as…`
49+
- **Excluded files**: Files marked as excluded are omitted from indexing, searching, and navigation, which significantly improves performance. Examples include `node_modules`, `logs`, `vendors`, `gradle`, etc.
50+
- **Tests**: Typically identifies the tests directory.
6151

62-
Specific IDEs might have other _File Colors_ preinstalled.
52+
**Note**: You can mark a directory as excluded by right-clicking it and selecting `Mark Directory as…`.
6353

64-
You can find them within `Settings → Appearance & Behavior → File Colors`.
54+
Depending on the IDE, other _File Colors_ might also be pre-installed. You can find them under `Settings/Preferences → Appearance & Behavior → File Colors`.
6555

66-
{% include figure.html content="/screens/fileColors.png" caption="File Colors" %}
56+
{% include figure.html content="/screens/colors/fileColors.png" caption="File Colors" %}
6757

68-
By using this settings screen, you can add new colors, share them across projects,
69-
disable them in specific components, or assign them different priority if needed.
58+
From this settings screen, you can add new colors, share them across projects, disable them for specific components, or adjust their priority.
7059

71-
**Tip**: there's also a nice plugin, [Project Tree Highlighter](https://plugins.jetbrains.com/plugin/13951-projecttree-color-highlighter),
72-
giving you the ability to colorize folders from the Project View directly.
60+
**Tip**: The [Project Tree Highlighter](https://plugins.jetbrains.com/plugin/13951-projecttree-color-highlighter) plugin also allows you to colorize folders directly from the Project View.
7361
{:class='card-panel'}
7462

75-
---
63+
----
7664

7765
### Scopes
7866

79-
The two pre-bundled options are pretty limited, but you can add your own file colors according to certain patterns.
80-
For example, differentiating between the `docs` directory than the rest of the source.
67+
While the pre-bundled options are a great start, you can create custom file colors using **Scopes**. Scopes allow you to define pattern-based rules to include or exclude specific directories.
8168

82-
To do so, you have to create a **Scope**.
83-
There you can define your pattern rules, which directories should be included in the scope and which should be excluded.
84-
Finally, add your new created scope in the _File Colors_ list, and rise it up to the top, so it won't be shrouded by other file colors.
69+
To set up a custom color:
70+
1. Create a **Scope** and define its rules.
71+
2. Add your new scope to the _File Colors_ list.
72+
3. Move it to the top of the list to ensure it isn't overridden by other colors.
8573

86-
{% include figure.html content="/screens/archive/scopes.png" caption="Scopes" %}
74+
{% include figure.html content="/screens/colors/scopes.png" caption="Scopes" %}
8775

88-
See more
89-
at [File Colors](https://www.jetbrains.com/help/idea/2017.3/file-colors.html?utm_medium=help_link&utm_source=from_product&utm_campaign=IU&utm_content=2017.3)
76+
{% include figure.html content="/screens/colors/scopes2.png" caption="Add File Colors To Scope" %}
77+
78+
For more information, visit the [official JetBrains documentation on File Colors](https://www.jetbrains.com/help/idea/file-colors.html).
9079

9180
-----
9281

9382
## Material File Colors
9483

95-
### Excluded files theme color
84+
### Theme-Specific File Colors
85+
86+
Themes can override default file colors to provide a palette that matches their specific aesthetic.
9687

97-
_File Colors_ are pretty neat, but the current prebundled _File Colors_ are adapted for the _Darcula/IntelliJ_ look and feels, not for the Material Themes.
88+
{% include figure.html content="/screens/colors/cobaltColors.png" caption="Cobalt2 File Colors" %}
9889

99-
To remedy this, the plugin is also coming prebundled with _File Colors_, specifically for **Excluded files**.
90+
{% include figure.html content="/screens/colors/catpuccinColors.png" caption="Catppuccin File Colors" %}
10091

101-
However, because the _File Colors_ are user settings, and because the user could have modified the default _Excluded Files_' color,
102-
the plugin couldn't override this setting with its own.
103-
Therefore, it's the responsibility of the user to change the color of the Excluded Files.
92+
Similarly, the themes included with this plugin provide their own optimized File Colors.
10493

105-
To do so, open the File Colors Settings (`Appearance > File Colors`), select the scope you want to change the color, for instance, "_Excluded Files_",
106-
and click to the _Edit_ button.
94+
{% include figure.html content="/screens/colors/materialColors.png" caption="Material File Colors" %}
10795

108-
There you should see a list of predefined colors, as well as one specific color named __Theme Excluded Color__,
109-
corresponding to the current theme's `Excluded Color`.
96+
### Excluded Files Theme Color
11097

111-
{% include figure.html content="/screens/excludedFilesColors.png" caption="Excluded Files Color" %}
98+
In addition, the plugin includes a specific color designed for **Excluded Files**.
11299

113-
Moreover, if you select this color and switch to another theme, the selected theme's excluded color should be applied automatically.
100+
Known as the **Excluded Files Color** in the theme nomenclature, this is typically a dimmed variant of the background color. It is automatically injected into the "Gray" File Color, making it ready for use with excluded files.
114101

115-
**Note**: the Project View won't get the color change right away, due to its caching feature.
116-
But this shall be solved eventually.
117-
{class='card-panel warn'}
102+
{% include figure.html content="/screens/colors/oceanicExcluded.png" caption="Material Oceanic Excluded Files Color" %}
118103

119-
### Other colors
104+
{% include figure.html content="/screens/colors/darkerExcluded.png" caption="Material Darker Excluded Files Color" %}
120105

121-
Aside from the _Theme Excluded Color_, the plugin also comes with other colors, better suited for the provided themes.
106+
{% include figure.html content="/screens/colors/spaceExcluded.png" caption="Material Space Excluded Files Color" %}
122107

123-
{% include figure.html content="/screens/excludedFilesColors2.png" caption="Other file colors" %}
108+
**Note**: While theme authors are not required to provide a specific "excluded files color," most also use the "Gray" File Color for this purpose.
109+
{:class='card-panel info'}
124110

125111
-----
126112

0 commit comments

Comments
 (0)