API Reference › components-react› Common

Common

Common classes used across various UI components.

Classes

Name Description  
UiComponents Manages the localization service for the components-react package.  

Constants

Name Description  
CheckBoxState State of a checkbox.  
Orientation Enumeration of orientation.  
TimeFormat Enumeration of time formats.  

Enumerations

Name Description  
SelectionMode Selection modes for Tree row selection  
SelectionModeFlags Selection mode flags for Tree row selection  

Global Functions

Name Description  
adjustDateToTimezone Adjust a Date object to show time in one time zone as if it is in the local time zone.  
hasSelectionModeFlag Determines if a SelectionMode is active  
HighlightedText Highlighted text  
matchLinks Returns a list of links from a text  
toDateString Format a date in a display string, optionally converting to time zone, if specified by timeZoneOffset  
toTimeString Format the time included in a date, optionally converting to time zone, if specified  
useAsyncValue Custom hook for working with possibly async values.  
useDebouncedAsyncValue Custom hook for working with promise values.  

Interfaces

Name Description  
DateFormatOptions Define formatting options for use when component are generating a formatted date string calling Date.toLocaleTimeString().  
HighlightedTextProps Properties of HighlightedText Deprecated
HighlightInfo Item highlight info used for identification of a specific highlight in an item  
HighlightingComponentProps Properties used for highlighting parts in item by given text and actively highlighting one highlight in a distinct item specified in activeHighlight  
IImageLoader Interface for an image loader.  
LoadedBinaryImage Image data for raw images  
LoadedImage Image data for string based images  
PageOptions Paging options.  

Type Aliases

Name Description  
CheckBoxState State of a checkbox.  
Image Image data returned by an IImageLoader  
ImageFileFormat Type of raw image format  
ImageSourceType Type of loaded image source:  
OnItemsDeselectedCallback Called after items were deselected.  
OnItemsSelectedCallback Called after items were selected.  
OnSelectionChanged Prototype for a Selection Changed handler  
Orientation Enumeration of orientation.  
TimeFormat Enumeration of time formats.  

Last Updated: 06 November, 2024