View source

class ThemeIcon

package vscode

@:jsRequire("vscode","ThemeIcon")

A reference to a named icon. Currently, {@link ThemeIcon.File File}, {@link ThemeIcon.Folder Folder}, and ThemeIcon ids are supported. Using a theme icon is preferred over a custom icon as it gives product theme authors the possibility to change the icons.

Note that theme icons can also be rendered inside labels and descriptions. Places that support theme icons spell this out and they use the $(<name>)-syntax, for instance quickPick.label = "Hello World $(globe)".

Static variables

staticread onlyFile:ThemeIcon

Reference to an icon representing a file. The icon is taken from the current file icon theme or a placeholder icon.

staticread onlyFolder:ThemeIcon

Reference to an icon representing a folder. The icon is taken from the current file icon theme or a placeholder icon.

Constructor

new(id:String, ?color:ThemeColor)

Creates a reference to a theme icon. @link TreeItem}.

Parameters:

id

id id of the icon. The available icons are listed in https://code.visualstudio.com/api/references/icons-in-labels#icon-listing.

color

optional ThemeColor for the icon. The color is currently only used in {

Variables

read onlycolor:Null<ThemeColor>

The optional ThemeColor of the icon. The color is currently only used in {@link TreeItem}.

read onlyid:String

The id of the icon. The available icons are listed in https://code.visualstudio.com/api/references/icons-in-labels#icon-listing.