core-react

Classes

Name Description
ActivateSettingsTabEvent Event class for this.onActivateSettingsTab which is emitted when API call needs to set the active settings tab (ie via Tool key-in). Deprecated
AutoSuggest Auto Suggest React component.
CheckListBox React component showing a list of Checkbox items. Deprecated
CheckListBoxItem Item with a checkbox added to a CheckListBox. Deprecated
ConditionalIconItem Class used to return an icon.
ContextMenu A context menu populated with ContextMenuItem components.
ContextMenuDivider Menu Divider for ContextMenu.
ContextMenuItem Menu Item class for use within a ContextMenu component.
ContextSubMenu Submenu wrapper class for use within a ContextMenu component.
Dialog Dialog React component with optional resizing and dragging functionality Deprecated
ExpandableList ExpandableList React component is a container for ExpandableBlock components. Deprecated
GlobalContextMenu GlobalContextMenu React component used to display a ContextMenu at the cursor
GlobalDialog GlobalDialog React component used to display a Dialog on the top of screen Deprecated
IconHelper Icon Helper Class used to store the data needed to generate an for use in any control that shows an icon.
ImageCheckBox ImageCheckBox React component shows a checked or unchecked image Deprecated
InputLabel Text input wrapper that provides additional styling and labeling Deprecated
LoadingBar A loading bar with optional percentage text. Deprecated
LoadingPrompt A component to display during loading that optionally shows percentage, status text and a cancel button. Deprecated
LoadingSpinner A loading spinner component that optionally shows a text message. Deprecated
LoadingStatus A loading indicator that shows status text along with the percentage. Deprecated
LocalStateStorage Implementation of UiStateStorage using Window.localStorage.
MessageBox Message Box React component.
MessageContainer Message Container React component.
Popup Popup React component displays a popup relative to an optional target element.
ProcessSettingsContainerCloseEvent Event class for this.onProcessSettingsContainerClose which is emitted when the settings container will be closed. Deprecated
ProcessSettingsTabActivationEvent Event class for this.onProcessSettingsTabActivation which is emitted when a new Tab needs to be activated. Deprecated
RadialButton Button for use within a RadialMenu Deprecated
RadialMenu A context menu arranged in a radial layout. Deprecated
ScrollPositionMaintainer A helper class to recursively save and restore scroll positions.
Input box for entering text to search for. Deprecated
SettingsManager Settings Manager class.
SettingsProvidersChangedEvent Event class for this.onSettingsProvidersChanged which is emitted when a new SettingsTabsProvider is added or removed. Deprecated
SvgPath Svg element wrapper with specified Svg paths.
Tabs Tabs meant to represent the current position in a page/section Deprecated
Timer Notifies handler after a set interval.
Tree Presentation React component for a Tree
TreeBranch Presentation React component for a Tree branch
TreeNode Presentation React component for a Tree node
TreeNodePlaceholder Presentation React component for a placeholder to be displayed instead of a node while it's being loaded
UiCore Manages the Localization service for the core-react package.
UiStateEntry A single UI State entry that is identified by namespace and setting name.

Constants

Name Description
BadgeType Specifies type of badge, if any, that should be overlaid on UI component.
DivWithOutsideClick Div element with Outside Click behavior Deprecated

Enumerations

Name Description
CheckBoxState State of a checkbox
ContextMenuDirection Enum to specify where a ContextMenu should anchor to its parent element
DialogAlignment Enum for dialog alignment Deprecated
HorizontalAlignment Enumeration for horizontal alignment.
InputStatus Enum for Input status Deprecated
Orientation Enumeration of orientation.
SortDirection Enumeration for sorting direction.
TimeFormat Enumeration of time formats.
UiStateStorageStatus Enum for UiStateStorage status.
VerticalAlignment Enumeration for vertical alignment.

Global Functions

Name Description
BlockText Styled block text React functional component Deprecated
BodyText Styled body text React functional component Deprecated
Centered Centered React functional component. Deprecated
CheckListBoxSeparator Separator added to a CheckListBox. Deprecated
DisabledText Styled disabled text React functional component Deprecated
Div Base div element React component Deprecated
ElementResizeObserver ElementResizeObserver provides functionality similar to ReactResizeDetector when a render function is specified.
ElementSeparator A movable button, which allows to change the ratio between left element and right element Deprecated
ExpansionToggle ExpansionToggle React component used by the TreeNode component to show collapsed or expanded state
FillCentered Full height & width and centered React functional component. Deprecated
FlexWrapContainer Flex Wrap Container React functional component. Deprecated
Gap Horizontal gap or space React component. Deprecated
getCssVariable Get CSS variable
getCssVariableAsNumber Get CSS variable as number
Icon Icon Functional component displays an icon based on an IconSpec.
IconInput Input component with icon to the left of the input field Deprecated
MessageRenderer React component renders a string, HTMLElement or React node in a div or span
MutedText Styled muted/gray text React functional component Deprecated
NumberInput Input component for numbers with up and down buttons to increment and decrement the value. Deprecated
PopupContextMenu Component that displays a ContextMenu within a Popup component, allowing the target element to be specified.
ResizableContainerObserver ResizableContainerObserver is a component that provides the functionality similar to the ReactResizeDetector option that call a function when
ScrollView Scroll View React functional component. Deprecated
SettingsContainer SettingsContainer component that displays Setting Tabs on Left and the P
StyledText The base component for other text components that pass a main CSS class name. Deprecated
UnderlinedButton A React component that makes text clickable and underlined 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.
useInterval Hook that create an interval and clears it when unloaded
useOnOutsideClick Invokes onOutsideClick handler when user clicks outside of referenced element.
useOptionalDisposable A custom hook which calls the factory method to create a disposable object
useSaveBeforeActivatingNewSettingsTab Hook to use within Settings Page component to allow saving the current page's data before loading to the requested Setting Tab's page.
useSaveBeforeClosingSettingsContainer Hook to use within Settings Page component to allow saving the current page's data before the Setting Container is closed.
VerticalTabs Vertical tabs meant to represent the current position in a page/section Deprecated
WebFontIcon WebFontIcon React component
withIsPressed withIsPressed is a React higher-order component that adds pointer and mouse events.
withOnOutsideClick withOnOutsideClick is a React higher-order component that adds outside click support.
withTimeout withTimeout is a React higher-order component that adds timeout support.

Interfaces

Name Description
ActivateSettingsTabEventArgs Arguments of this.onActivateSettingsTab event. Deprecated
AutoSuggestData Data for the AutoSuggest options
AutoSuggestProps Properties for the AutoSuggest component.
CheckBoxInfo A data type that holds all the checkbox display attributes
CheckListBoxItemProps Properties for the CheckListBoxItem component Deprecated
ClassNameProps Props used by components that expect class name to be passed in.
CommonDivProps Common properties using a div element.
CommonProps Common props used by components.
ContextMenuItemProps Properties for the ContextMenuItem component
ContextMenuProps Properties for the ContextMenu component
ContextSubMenuProps Properties for the ContextSubMenu component
DialogProps Properties for the Dialog component Deprecated
DivProps Properties for the Div component Deprecated
ElementSeparatorProps Properties of ElementSeparator React component Deprecated
ExpandableListProps Properties for ExpandableList component Deprecated
ExpansionToggleProps Properties for the ExpansionToggle component
GapProps Properties for the Gap component. Deprecated
GlobalContextMenuProps Properties for the GlobalContextMenu component
GlobalDialogProps Properties for the GlobalDialog component Deprecated
GlobalDialogState State properties for the GlobalDialog component Deprecated
IconInputProps Properties for the IconInput component Deprecated
IconProps Properties for the Icon React component
ImageCheckBoxProps Properties for the ImageCheckBox component Deprecated
InputLabelProps Properties for InputLabel components Deprecated
LabeledComponentProps Properties for labeled components Deprecated
LoadingBarProps Properties for LoadingBar component Deprecated
LoadingPromptProps Properties for LoadingPrompt component Deprecated
LoadingSpinnerProps Properties for LoadingSpinner component Deprecated
LoadingStatusProps Properties for LoadingStatus component Deprecated
MainTabsProps Properties for the base Tabs component Deprecated
MessageBoxProps Properties for the MessageBox component
MessageContainerProps Properties for the MessageContainer component
MessagedComponentProps Properties for components with messages Deprecated
MessageRendererProps Properties for the MessageRenderer component
NoChildrenProps Props used by components that do not expect children to be passed in.
NodeCheckboxProps Properties for Tree Node CheckBox
NumberInputProps Properties for the NumberInput component Deprecated
PopupContextMenuProps Properties for PopupContextMenu component
PopupProps Properties for the Popup component
ProcessSettingsContainerCloseEventArgs Arguments of this.onProcessSettingsContainerClose event. Deprecated
ProcessSettingsTabActivationEventArgs Arguments of this.onProcessSettingsTabActivation event. Deprecated
RadialButtonProps Properties for RadialButton component Deprecated
RadialMenuProps Properties for RadialMenu Deprecated
RatioChangeResult Results returned by onRatioChanged callback for determining new ratio and whether the ratio was updated. Deprecated
ReactMessage Describes a React based message
RectangleProps Describes 2d bounds.
RenderPropsArgs Prop the ElementResizeObserver sends to the render function.
SearchBoxProps Properties for SearchBox component Deprecated
SettingsContainerProps
SettingsProvidersChangedEventArgs Arguments of this.onSettingsProvidersChanged event. Deprecated
SettingsTabEntry Interface used to populate a tab entry in the SettingContainer control
SettingsTabsProvider Setting Provider interface.
SizeProps Describes 2d dimensions.
StyledTextProps Properties for StyledText component Deprecated
SvgPathProps Properties of SvgPath component.
TabLabel TabLabel provides ability to define label, icon, and tooltip for a tab entry. Deprecated
TabsProps Properties for the VerticalTabs component Deprecated
TextProps Properties for various text components Deprecated
TreeBranchProps Properties for TreeBranch React component
TreeNodePlaceholderProps Properties for the TreeNodePlaceholder React component
TreeNodeProps Properties for the TreeNode React component
TreeProps Properties for the Tree presentational React component
UiStateStorage Interface for getting, saving and deleting settings.
UiStateStorageResult Interface for result of accessing UI state setting in UiStateStorage.
UnderlinedButtonProps Properties for the UnderlinedButton React component Deprecated
WebFontIconProps Properties for the WebFontIcon React component
WithIsPressedProps Properties for withIsPressed React higher-order component
WithOnOutsideClickProps Properties for withOnOutsideClick React higher-order component
WithTimeoutProps Properties for withTimeout React higher-order component

Type Aliases

Name Description
AsyncGetAutoSuggestDataFunc Prototype for async function returning AutoSuggestData
BadgeType Specifies type of badge, if any, that should be overlaid on UI component.
ExecuteHandler Signature for Timer execute callback.
GetAutoSuggestDataFunc Prototype for function returning AutoSuggestData
IconSpec Prototype for an IconSpec which can be a string, ReactNode or ConditionalStringValue.
MessageType Types for message
NodeCheckboxRenderer Type for node Checkbox renderer
NodeCheckboxRenderProps Props for node Checkbox renderer
Omit Used to omit properties in a given interface
OmitChildrenProp Omit children property from T.
OutsideClickEvent
RadialSizeType Type for ProgressRadialProps.size Deprecated
StepFunctionProp Step function prototype for NumberInput component Deprecated

Last Updated: 07 June, 2024