API Reference › core-react› Utilities

Utilities

Various utility classes, functions and React hooks for working with a UI.

Classes

Name Description  
IconHelper Icon Helper Class used to store the data needed to generate an for use in any control that shows an icon. Deprecated
ScrollPositionMaintainer A helper class to recursively save and restore scroll positions. Deprecated
Timer Notifies handler after a set interval. Deprecated
UiCore Manages the Localization service for the core-react package.  

Constants

Name Description  
BadgeType Specifies type of badge, if any, that should be overlaid on UI component.  

Global Functions

Name Description  
ElementResizeObserver ElementResizeObserver provides functionality similar to ReactResizeDetector when a render function is specified. Deprecated
getCssVariable Get CSS variable Deprecated
getCssVariableAsNumber Get CSS variable as number Deprecated
ResizableContainerObserver ResizableContainerObserver is a component that provides the functionality similar to the ReactResizeDetector option that call a function when Deprecated
useCrossOriginPopup Hook that will show a popup window  
useDisposable A custom hook which creates a disposable object and manages its disposal on unmount Deprecated
useEffectSkipFirst Custom hook which works like useEffect hook, but does not invoke callback when effect is triggered for the first time. Deprecated
useInterval Hook that create an interval and clears it when unloaded Deprecated
useOnOutsideClick Invokes onOutsideClick handler when user clicks outside of referenced element. Deprecated
useOptionalDisposable A custom hook which calls the factory method to create a disposable object Deprecated

Interfaces

Name Description  
ClassNameProps Props used by components that expect class name to be passed in. Deprecated
CommonDivProps Common properties using a div element. Deprecated
CommonProps Common props used by components. Deprecated
NoChildrenProps Props used by components that do not expect children to be passed in. Deprecated
RectangleProps Describes 2d bounds.  
RenderPropsArgs Prop the ElementResizeObserver sends to the render function.  
SizeProps Describes 2d dimensions.  

Type Aliases

Name Description  
BadgeType Specifies type of badge, if any, that should be overlaid on UI component.  
ExecuteHandler Signature for Timer execute callback. Deprecated
Omit Used to omit properties in a given interface  
OmitChildrenProp Omit children property from T.  
OutsideClickEvent Deprecated

Last Updated: 17 June, 2024