尝试以扩展 VS Code 中的代理模式!

产品图标主题

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 字体。

  • 将格式设置为 '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

dev tools inspect tool

示例

产品颜色主题示例 可用作实验场所。