Class IconRegistry

Registry of icon sources used by editor and toolbar components.

Index

Constructors

Methods

register registerSymbol registerSvg registerUrl has get createElement

Constructors

constructor

new IconRegistry(): IconRegistry
Returns IconRegistry

Methods

`Static`register

register(id: string, source: IconSource): void
Register an icon by a short key, without the 'icon-' prefix.
Parameters
- id: string
  The icon identifier.
- source: IconSource
  The icon source.
Returns void
- Defined in src/factory/icon.registry.ts:19

`Static`registerSymbol

registerSymbol(id: string, _symbolId: string, symbolMarkup: string): void
Register a symbol-defined icon. The symbol markup is converted to an inline SVG so no sprite injection is needed.
Parameters
- id: string
  The icon identifier.
- _symbolId: string
  The symbol identifier (unused).
- symbolMarkup: string
  The SVG symbol markup.
Returns void
- Defined in src/factory/icon.registry.ts:30

`Static`registerSvg

registerSvg(id: string, markup: string): void
Register a standalone SVG string as an icon.
Parameters
- id: string
  The icon identifier.
- markup: string
  The SVG markup string.
Returns void
- Defined in src/factory/icon.registry.ts:44

`Static`registerUrl

registerUrl(id: string, src: string): void
Register an external URL as an icon.
Parameters
- id: string
  The icon identifier.
- src: string
  The URL of the icon.
Returns void
- Defined in src/factory/icon.registry.ts:53

`Static`has

has(id: string): boolean
Checks if an icon with the given identifier is registered.
Parameters
- id: string
  The icon identifier.
Returns boolean
True if the icon is registered, false otherwise.
- Defined in src/factory/icon.registry.ts:62

`Static`get

get(id: string): IconSource | undefined
Retrieves the icon source for the given identifier.
Parameters
- id: string
  The icon identifier.
Returns IconSource | undefined
The icon source if found, undefined otherwise.
- Defined in src/factory/icon.registry.ts:71

`Static`createElement

createElement(id: string, size?: number): Element | null
Returns an Element rendering the icon inline, or null if not found.
Parameters
- id: string
  The icon identifier.
- Optionalsize: number
  The desired size of the icon in pixels.
Returns Element | null
An Element representing the icon, or null if not found.
- Defined in src/factory/icon.registry.ts:81