文件图标主题
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”匹配是最强的匹配,与文件名关联的图标将优先于匹配的文件扩展名或匹配的语言 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
部分允许你声明任意数量要使用的字形字体。你稍后可以在图标定义中引用这些字体。如果图标定义未指定 font 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