文件图标主题

Visual Studio Code 会在整个 UI 的文件名旁边显示图标,扩展程序可以贡献新的文件图标集供用户选择。

添加新的文件图标主题

你可以使用图标(最好是 SVG)和图标字体创建自己的文件图标主题。作为示例,请查看两个内置主题:MinimalSeti

首先,创建一个 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 的图标。

(*) 某些属性键(folderNamesfolderNamesExpandedfileExtensionsfileNames)可以以单个父路径段为前缀。仅当资源的直接父文件夹与父路径文件夹匹配时,才会使用该图标。这可用于为特定文件夹(例如 system)中的资源提供不同的外观。

  "fileNames": {
    "system/win.ini": "_win_ini_file"
  },

system/win.ini 表示该关联匹配直接位于 system 文件夹下的名为 win.ini 的文件。

  "fileExtensions": {
    "system/ini": "_ini_file"
  },

system/ini 表示该关联匹配直接位于 system 文件夹下的所有 *.ini 文件。

文件扩展名匹配优于语言匹配,但弱于文件名匹配。带有父路径段的匹配优于不带此类段的同类匹配。

带父级的文件名匹配 > 文件名匹配 > 带父级的文件扩展名匹配 > 文件扩展名匹配 > 语言匹配 ...

lighthighContrast 部分具有与上述相同的属性。它们允许为相应的主题覆盖图标。

字体定义

fonts 部分允许你声明任意数量想要使用的字形字体。稍后可以在图标定义中引用这些字体。如果图标定义未指定字体 id,将使用最先声明的字体作为默认值。

将字体文件复制到你的扩展中并相应地设置路径。建议使用 WOFF 字体。

  • 将格式设置为 'woff'。
  • weight 属性值定义在 此处
  • style 属性值定义在 此处
  • 大小应相对于使用图标的字体大小。因此,请务必使用百分比。
{
  "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
© . This site is unofficial and not affiliated with Microsoft.