Interface IconRegistry

interface IconRegistry {
    deregisterIcon(id: string): void;
    deregisterIconFont(id: string): void;
    getIconFont(id: string): undefined | IconFontDefinition;
    registerIcon(
        id: string,
        defaults: IconDefinition | ThemeIcon,
        description?: string,
    ): ThemeIcon;
    registerIconFont(
        id: string,
        definition: IconFontDefinition,
    ): IconFontDefinition;
}

Implemented by

MonacoIconRegistry

Index

Methods

deregisterIcon deregisterIconFont getIconFont registerIcon registerIconFont

Methods

deregisterIcon

deregisterIcon(id: string): void
Deregister a icon from the registry.
Parameters
- id: string
  The icon id
Returns void
- Defined in packages/core/src/browser/icon-registry.ts:66

deregisterIconFont

deregisterIconFont(id: string): void
Deregister an icon font from the registry.
Parameters
- id: string
  The icon font id
Returns void
- Defined in packages/core/src/browser/icon-registry.ts:79

getIconFont

getIconFont(id: string): undefined | IconFontDefinition
Get the icon font for the given id
Parameters
- id: string
  The icon font id
Returns undefined | IconFontDefinition
- Defined in packages/core/src/browser/icon-registry.ts:85

registerIcon

registerIcon(
    id: string,
    defaults: IconDefinition | ThemeIcon,
    description?: string,
): ThemeIcon
Register a icon to the registry.
Parameters
- id: string
  The icon id
- defaults: IconDefinition | ThemeIcon
  The default values
- Optionaldescription: string
  The description
Returns ThemeIcon
- Defined in packages/core/src/browser/icon-registry.ts:60

registerIconFont

registerIconFont(id: string, definition: IconFontDefinition): IconFontDefinition
Register a icon font to the registry.
Parameters
- id: string
  The icon font id
- definition: IconFontDefinition
  The icon font definition
Returns IconFontDefinition
- Defined in packages/core/src/browser/icon-registry.ts:73