产品图标主题
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
。
示例
产品颜色主题示例可以用作演练场。