Class: IconRegistry
Defined in: src/ui/icons/index.ts:152
The icons PaintCanvas's elements show, by name. Implementers can replace any icon (or add their own) with an image URL, e.g. an SVG data URL.
Dispatches a change event when icons change, so elements show the new ones.
Example
icons.register({ brush: "/my-icons/brush.svg" });
icons.get("brush"); // "/my-icons/brush.svg"
Extends
EventTarget
Constructors
Constructor
new IconRegistry(
initial?):IconRegistry
Defined in: src/ui/icons/index.ts:155
Parameters
initial?
Readonly<Record<string, string>> = DEFAULT_ICONS
Returns
IconRegistry
Overrides
EventTarget.constructor
Accessors
names
Get Signature
get names():
string[]
Defined in: src/ui/icons/index.ts:161
Names of all registered icons
Returns
string[]
Methods
addEventListener()
addEventListener(
type,callback,options?):void
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:14380
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.
Parameters
type
string
callback
EventListenerOrEventListenerObject | null
options?
boolean | AddEventListenerOptions
Returns
void
Inherited from
EventTarget.addEventListener
dispatchEvent()
dispatchEvent(
event):boolean
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:14386
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().
Parameters
event
Event
Returns
boolean
Inherited from
EventTarget.dispatchEvent
get()
get(
name):string|undefined
Defined in: src/ui/icons/index.ts:168
An icon's URL, or undefined if there's none by that name.
Parameters
name
string
Returns
string | undefined
register()
register(
icons):void
Defined in: src/ui/icons/index.ts:175
Add or replace icons, by name. Dispatches change.
Parameters
icons
Readonly<Record<string, string>>
Returns
void
removeEventListener()
removeEventListener(
type,callback,options?):void
Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.dom.d.ts:14392
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.
Parameters
type
string
callback
EventListenerOrEventListenerObject | null
options?
boolean | EventListenerOptions
Returns
void
Inherited from
EventTarget.removeEventListener
reset()
reset():
void
Defined in: src/ui/icons/index.ts:183
Put back the icons that come with PaintCanvas, removing any added. Dispatches change.
Returns
void