文件图标主题
Visual Studio Code 在其 UI 中会在文件名旁边显示图标,扩展程序可以提供新的文件图标集供用户选择。
添加新的文件图标主题
您可以从图标(最好是 SVG)和图标字体创建自己的文件图标主题。例如,请查看内置的两个主题:Minimal 和 Seti。
首先,创建一个 VS Code 扩展并添加 iconTheme 贡献点。
{
"contributes": {
"iconThemes": [
{
"id": "turtles",
"label": "Turtles",
"path": "./fileicons/turtles-icon-theme.json"
}
]
}
}
id 是图标主题的标识符。它用作设置中的标识符,因此请确保其唯一且易于阅读。label 显示在文件图标主题选择器下拉菜单中。path 指向扩展中定义图标集的那个文件。如果您的图标集名称遵循 *icon-theme.json 命名约定,您将在 VS Code 中获得完成支持和悬停提示。
文件图标集文件
文件图标集文件是一个 JSON 文件,由文件图标关联和图标定义组成。
图标关联将文件类型('file'、'folder'、'json-file' 等)映射到图标定义。图标定义指定了图标的位置:它可以是一个图像文件,也可以是字体中的字形。
图标定义
iconDefinitions 部分包含所有定义。每个定义都有一个 id,将用于引用该定义。一个定义也可以被多个文件关联引用。
{
"iconDefinitions": {
"_folder_dark": {
"iconPath": "./images/Folder_16x_inverse.svg"
}
}
}
上面的图标定义包含一个标识符为 _folder_dark 的定义。
支持以下属性
iconPath:使用 svg/png 时:图像的路径。fontCharacter:使用字形字体时:要使用的字体字符。fontColor:使用字形字体时:要使用的字形颜色。fontSize:使用字体时:字体大小。默认情况下,使用字体规范中指定的尺寸。应为相对于父字体大小的相对尺寸(例如 150%)。fontId:使用字体时:字体的 id。如果未指定,将选择字体规范部分中指定的第一个字体。
文件关联
图标可以与文件夹、文件夹名称、文件、文件扩展名、文件名以及语言 ID 相关联。
此外,这些关联中的每一个都可以针对“light”和“highContrast”颜色主题进行细化。
每个文件关联都指向一个图标定义。
{
"file": "_file_dark",
"folder": "_folder_dark",
"folderExpanded": "_folder_open_dark",
"folderNames": {
".vscode": "_vscode_folder"
},
"fileExtensions": {
"ini": "_ini_file"
},
"fileNames": {
"win.ini": "_win_ini_file"
},
"languageIds": {
"ini": "_ini_file"
},
"light": {
"folderExpanded": "_folder_open_light",
"folder": "_folder_light",
"file": "_file_light",
"fileExtensions": {
"ini": "_ini_file_light"
}
},
"highContrast": {}
}
file是默认的文件图标,显示给所有不匹配任何扩展名、文件名或语言 ID 的文件。目前,文件图标定义的属性将被继承(仅对字形字体相关,对于 fontSize 很有用)。folder是折叠文件夹的文件夹图标,如果未设置folderExpanded,则也用于展开的文件夹。可以使用folderNames属性关联特定文件夹名称的图标。文件夹图标是可选的。如果未设置,则文件夹将不显示图标。folderExpanded是展开文件夹的文件夹图标。展开的文件夹图标是可选的。如果未设置,将显示为folder定义的图标。folderNames将文件夹名称与图标相关联。集合的键是文件夹名称,可以选择性地以单个父路径段(*)为前缀。不支持模式或通配符。文件夹名称匹配不区分大小写。folderNamesExpanded将展开文件夹的文件夹名称与图标相关联。集合的键是文件夹名称,可以选择性地以单个父路径段(*)为前缀。不支持模式或通配符。文件夹名称匹配不区分大小写。rootFolder是折叠工作区根文件夹的文件夹图标,如果未设置rootFolderExpanded,则也用于展开的工作区根文件夹。如果未设置,将为工作区根文件夹显示为folder定义的图标。rootFolderExpanded是展开工作区根文件夹的文件夹图标。如果未设置,将为展开的工作区根文件夹显示为rootFolder定义的图标。rootFolderNames将根文件夹名称与图标相关联。集合的键是文件夹名称。不支持模式或通配符。根文件夹名称匹配不区分大小写。rootFolderNamesExpanded将展开文件夹的根文件夹名称与图标相关联。集合的键是文件夹名称。不支持模式或通配符。根文件夹名称匹配不区分大小写。languageIds将语言与图标相关联。集合中的键是语言 ID,如语言贡献点中定义的。文件的语言是根据语言贡献中定义的扩展名和文件名来确定的。请注意,不考虑语言贡献的“第一行匹配”。fileExtensions将文件扩展名与图标相关联。集合中的键是文件扩展名。扩展名是点之后的文件名片段(不包括点)。具有多个点的文件名(例如lib.d.ts)可以匹配多个扩展名;“d.ts”和“ts”。可以选择性地,文件扩展名可以以单个父路径段(*)为前缀。扩展名比较时不区分大小写。fileNames将文件名与图标相关联。集合中的键是完整的文件名,不包括任何路径段。可以选择性地,文件扩展名可以以单个父路径段(*)为前缀。不支持模式或通配符。文件名匹配不区分大小写。`fileName` 匹配是最强的匹配,关联到文件名的图标将优先于匹配的 `fileExtension` 和 `language ID` 的图标。
(*) 某些属性键(folderNames、folderNamesExpanded、fileExtensions、fileNames)可以以单个父路径段为前缀。仅当资源的直接父文件夹与父路径文件夹匹配时,才使用该图标。这可用于为特定文件夹(例如 system)中的资源提供不同的外观。
"fileNames": {
"system/win.ini": "_win_ini_file"
},
system/win.ini 表示关联匹配直接位于 system 文件夹中的名为 win.ini 的文件。
"fileExtensions": {
"system/ini": "_ini_file"
},
system/ini 表示关联匹配直接位于 system 文件夹中的名为 *.ini 的文件。
文件扩展名匹配优先于语言匹配,但弱于文件名匹配。带有父路径段的匹配优先于相同类型的没有父路径段的匹配。
带父路径的文件名匹配 > 文件名匹配 > 带父路径的文件扩展名匹配 > 文件扩展名匹配 > 语言匹配 ...
light 和 highContrast 部分具有与上面列出的相同的文件关联属性。它们允许覆盖对应主题的图标。
字体定义
fonts 部分允许您声明任意数量的字形字体。之后,您可以在图标定义中引用这些字体。如果在图标定义中未指定字体 id,则将第一个声明的字体用作默认字体。
将字体文件复制到您的扩展中,并相应地设置路径。建议使用WOFF 字体。
{
"fonts": [
{
"id": "turtles-font",
"src": [
{
"path": "./turtles.woff",
"format": "woff"
}
],
"weight": "normal",
"style": "normal",
"size": "150%"
}
],
"iconDefinitions": {
"_file": {
"fontCharacter": "\\E002",
"fontColor": "#5f8b3b",
"fontId": "turtles-font"
}
}
}
文件图标主题中的文件夹图标
当文件夹图标足以指示文件夹的展开状态时,文件图标主题可以指示文件资源管理器不要显示默认文件夹图标(旋转三角形或“小三角”)。通过在文件图标主题定义文件中设置 "hidesExplorerArrows":true 来启用此模式。
语言默认图标
语言贡献者可以为语言定义一个图标。
{
"contributes": {
"languages": [
{
"id": "latex",
// ...
"icon": {
"light": "./icons/latex-light.png",
"dark": "./icons/latex-dark.png"
}
}
]
}
}
如果文件图标主题仅为该语言提供通用文件图标,则会使用该图标。
仅当以下情况时显示语言默认图标:
- 文件图标主题具有特定的文件图标。例如,
Minimal没有特定的文件图标,因此不使用语言默认图标。 - 文件图标主题不包含给定语言、文件扩展名或文件名的图标。
- 文件图标主题未定义
"showLanguageModeIcons":false。
语言默认图标始终显示,如果:
- 文件图标主题定义了
"showLanguageModeIcons":true。