Utilities

Various utility classes for working with a UI.

Classes

Name Description  
IconSpecUtilities Creates an IconSpec with an SVG source and gets the SVG source from an IconSpec.  
UiError iTwin.js UI UiError class is a subclass of BentleyError.  
UiEvent iTwin.js UI UiEvent class is a subclass of BeEvent with argument type safety.  
UiEventDispatcher This class is used to send eventIds to interested UI components so the component can determine if it needs  
UiSyncEvent UiSync Event class.  

Enumerations

Name Description  
FunctionKey Enumeration for Function Keys  
SpecialKey Enumeration for Special Keys  

Global Functions

Name Description  
isArrowKey Determines if a KeyboardEvent.key is an Arrow key  

Interfaces

Name Description  
IMatch Interface that returns indices of matches  
PointProps Describes 2d points.  
UiSyncEventArgs UiSync Event arguments.  

Type Aliases

Name Description  
OnCancelFunc  
OnItemExecutedFunc  
OnNumberCommitFunc  
OnValueCommitFunc  

Last Updated: 30 November, 2023