Utilities

The Utilities category in the @bentley/ui-core package includes various utility classes, functions and React hooks for working with a UI.

• ClassNameProps - Props used by components that expect a CSS class name to be passed in
• CommonProps - Common props used by components; includes style for CSS properties
• CommonDivProps - Common properties using a <div> element
• IconHelper - Icon Helper Class used to store the data needed to generate an <Icon> for use in any control that shows an icon
• NoChildrenProps - Props used by components that do not expect children to be passed in
• OmitChildrenProp - Omit children property
• PointProps - Describes 2d points
• RectangleProps - Describes 2d bounds
• SizeProps - Describes 2d dimensions
• Timer - Notifies handler after a set interval
• UiCore - Manages the I18N service for the ui-core package
• useDisposable - Custom hook which creates a disposable object and manages its disposal on unmount or factory method change
• useEffectSkipFirst - Custom hook which works like useEffect hook, but does not invoke callback when effect is triggered for the first time
• useOptionalDisposable - Custom hook which calls the factory method to create a disposable object which might as well be undefined. If the result was a disposable object, the hook takes care of disposing it when necessary.

API Reference

• Utilities

Last Updated: 12 June, 2024