产品图标主题
Visual Studio Code 包含一组内置图标,这些图标用于视图和编辑器中,但也可以在悬停、状态栏甚至扩展中引用。例如,筛选操作按钮和视图中的图标、状态栏中的图标、断点以及树和编辑器中的折叠图标。
产品图标主题允许扩展重新定义这些图标,为 VS Code 提供自定义外观。产品图标主题不包括文件图标(由文件图标主题覆盖)和扩展贡献的图标。
VS Code 要求图标在图标字体中定义为字形,并且(目前)将产品图标限制为由单一颜色组成。图标使用的颜色取决于其显示位置,并由活动颜色主题定义。
添加新的产品图标主题
要定义自己的产品图标主题,首先创建一个 VS Code 扩展,并将 productIconThemes
贡献点添加到扩展的 package.json
中。
{
"contributes": {
"productIconThemes": [
{
"id": "aliensAreBack",
"label": "Aliens Are Back",
"path": "./producticons/aliens-product-icon-theme.json"
}
]
}
}
id
是产品图标主题的标识符。它用于设置中,因此请确保其唯一且可读。label
显示在产品图标主题选择器下拉列表中。path
指向扩展中定义图标集的文件。如果您的文件名遵循 *product-icon-theme.json
命名方案,则在 VS Code 中编辑产品图标主题文件时,您将获得自动补全支持和悬停提示。
产品图标定义文件
产品图标定义文件是一个 JSON 文件,定义了一个或多个图标字体和一组图标定义。
字体定义
fonts
部分允许您声明任意数量的字形字体,但必须至少定义一个字体定义。
这些字体稍后可以在图标定义中引用。如果图标定义未指定字体 ID,则声明的第一个字体将用作默认字体。
将字体文件复制到您的扩展中并相应地设置路径。
建议您使用 WOFF 字体。
{
"fonts": [
{
"id": "alien-font",
"src": [
{
"path": "./alien.woff",
"format": "woff"
}
],
"weight": "normal",
"style": "normal"
}
]
}
图标定义
VS Code 定义了一个图标 ID 列表,视图通过这些 ID 引用图标。产品图标的 iconDefinitions
部分将新图标分配给这些 ID。
每个定义都使用 fontId
来引用 fonts
部分中定义的其中一个字体。如果省略 fontId
,则使用字体定义中列出的第一个字体。
{
"iconDefinitions": {
"dialog-close": {
"fontCharacter": "\\43",
"fontId": "alien-font"
}
}
}
所有图标标识符的列表可在图标参考中找到。
开发和测试
VS Code 内置了对 package.json
文件以及产品图标主题文件的编辑支持。为此,您的主题文件名需要以 product-icon-theme.json
结尾。这将启用所有属性(包括已知图标 ID)的代码补全以及悬停和验证功能。
要试用产品图标主题,请在 VS Code 中打开扩展文件夹并按 F5。这将在扩展开发宿主窗口中运行扩展。该窗口已启用您的扩展,并且扩展将自动切换到第一个产品图标主题。
此外,主题文件会监视更改,并且只要主题文件被修改,图标的更新就会自动应用。当您处理产品图标定义文件时,您将在保存时实时看到更改。
要在产品图标主题之间切换,请使用命令 **首选项:产品图标主题**。
要查找 VS Code UI 中某个位置使用的图标,请通过运行 **帮助 > 切换开发人员工具** 打开开发人员工具,然后
- 点击左上角的开发人员工具检查工具。
- 将鼠标移到图标上进行检查。
- 如果图标的类名是
codicon.codicon-remote
,则图标 ID 为remote
。
示例
产品颜色主题示例可用作练习场。