Skip to main content

iconThemesModules

MS Code Extension API


MS Code Extension API / core/extensionAPI/modules/iconThemesModules

core/extensionAPI/modules/iconThemesModules

Functions

createIconThemesModule()

createIconThemesModule(_extId): object

Defined in: core/extensionAPI/modules/iconThemesModules.ts:6

Parameters

_extId

string

Returns

object

iconThemes

iconThemes: object

iconThemes.getActiveThemeId

getActiveThemeId: () => string

Returns the unique ID of the currently active icon theme.

Returns

string

iconThemes.getAll

getAll: () => IconThemeDefinition[]

Retrieves a list of all registered icon themes.

Returns

IconThemeDefinition[]

iconThemes.onDidChangeIconTheme

onDidChangeIconTheme: (callback) => () => void

Fires when the active icon theme changes.

Parameters
callback

(themeId) => void

Returns

A function to unsubscribe from the event.

() => void

Example
const themeListener = mscode.themes.onDidChangeColorTheme((newThemeId) => {
console.log("Color theme changed to:", newThemeId);
});
iconThemes.register

register: (def) => object

Registers a Type-Safe JavaScript/TypeScript icon theme object.

Parameters
def

IconThemeDefinition

Returns

object

dispose

dispose: () => void

Returns

void

iconThemes.registerFromJson

registerFromJson: (json) => object

Registers an icon theme from a raw JSON string or object.

Parameters
json

string | object

Returns

object

dispose

dispose: () => void

Returns

void

iconThemes.setTheme

setTheme: (id) => void

Switches the editor to a registered icon theme.

Parameters
id

string

Returns

void