core-react
Classes
Name | Description | |
---|---|---|
ActivateSettingsTabEvent | Event class for onActivateSettingsTab which is emitted when API call needs to set the active settings tab (ie via Tool key-in). | |
AutoSuggest | Auto Suggest React component. | |
CheckListBox | React component showing a list of Checkbox items. | |
CheckListBoxItem | Item with a checkbox added to a CheckListBox. | |
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 | |
ExpandableList | ExpandableList React component is a container for ExpandableBlock components. | |
ExpansionToggle | ExpansionToggle React component used by the TreeNode component to show collapsed or expanded state | |
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 | |
IconHelper | Icon Helper Class used to store the data needed to generate an |
|
IconWebComponent | IconWebComponent loads icon from an svg path | |
ImageCheckBox | ImageCheckBox React component shows a checked or unchecked image | |
InputLabel | Text input wrapper that provides additional styling and labeling | |
LoadingBar | A loading bar with optional percentage text. | |
LoadingPrompt | A component to display during loading that optionally shows percentage, status text and a cancel button. | |
LoadingSpinner | A loading spinner component that optionally shows a text message. | |
LoadingStatus | A loading indicator that shows status text along with the percentage. | |
LocalStateStorage | Implementation of UiStateStorage using Window.localStorage. | |
Message Box React component. | ||
Message Container React component. | ||
Popup | Popup React component displays a popup relative to an optional target element. | |
ProcessSettingsContainerCloseEvent | Event class for onProcessSettingsContainerClose which is emitted when the settings container will be closed. | |
ProcessSettingsTabActivationEvent | Event class for onProcessSettingsTabActivation which is emitted when a new Tab needs to be activated. | |
RadialButton | Button for use within a RadialMenu | |
RadialMenu | A context menu arranged in a radial layout. | |
ScrollPositionMaintainer | A helper class to recursively save and restore scroll positions. | |
SearchBox | Input box for entering text to search for. | |
SettingsManager | Settings Manager class. | |
SettingsProvidersChangedEvent | Event class for onSettingsProvidersChanged which is emitted when a new SettingsTabsProvider is added or removed. | |
SvgPath | Svg element wrapper with specified Svg paths. | |
Tabs | Tabs meant to represent the current position in a page/section | |
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 enter that is identified by namespace and setting name. |
Constants
Name | Description | |
---|---|---|
DivWithOutsideClick | Div element with Outside Click behavior |
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 | |
HorizontalAlignment | Enumeration for horizontal alignment. | |
InputStatus | Enum for Input status | |
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 | |
BodyText | Styled body text React functional component | Deprecated |
Centered | Centered React functional component. | |
CheckListBoxSeparator | Separator added to a CheckListBox. | |
DisabledText | Styled disabled text React functional component | |
Div | Base div element React component | |
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 | |
FillCentered | Full height & width and centered React functional component. | |
FlexWrapContainer | Flex Wrap Container React functional component. | |
Gap | Horizontal gap or space React component. | |
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 | |
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. | |
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. | |
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 | |
useCrossOriginPopup | Hook that will show a popup window | |
useDisposable | A custom hook which creates a disposable object and manages its disposal on unmount | |
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 | |
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 onActivateSettingsTab event. | |
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 | |
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 | |
DivProps | Properties for the Div component | |
ElementSeparatorProps | Properties of ElementSeparator React component | |
ExpandableListProps | Properties for ExpandableList component | |
ExpansionToggleProps | Properties for the ExpansionToggle component | |
GapProps | Properties for the Gap component. | |
GlobalContextMenuProps | Properties for the GlobalContextMenu component | |
GlobalDialogProps | Properties for the GlobalDialog component | |
GlobalDialogState | State properties for the GlobalDialog component | |
IconInputProps | Properties for the IconInput component | |
IconProps | Properties for the Icon React component | |
ImageCheckBoxProps | Properties for the ImageCheckBox component | |
InputLabelProps | Properties for InputLabel components | |
LabeledComponentProps | Properties for labeled components | |
LoadingBarProps | Properties for LoadingBar component | |
LoadingPromptProps | Properties for LoadingPrompt component | |
LoadingSpinnerProps | Properties for LoadingSpinner component | |
LoadingStatusProps | Properties for LoadingStatus component | |
MainTabsProps | Properties for the base Tabs component | |
Properties for the MessageBox component | ||
Properties for the MessageContainer component | ||
Properties for components with messages | ||
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 | |
PopupContextMenuProps | Properties for PopupContextMenu component | |
PopupProps | Properties for the Popup component | |
ProcessSettingsContainerCloseEventArgs | Arguments of onProcessSettingsContainerClose event. | |
ProcessSettingsTabActivationEventArgs | Arguments of onProcessSettingsTabActivation event. | |
RadialButtonProps | Properties for RadialButton component | |
RadialMenuProps | Properties for RadialMenu | |
RatioChangeResult | Results returned by onRatioChanged callback for determining new ratio and whether the ratio was updated. | |
Describes a React based message | ||
RectangleProps | Describes 2d bounds. | |
RenderPropsArgs | Prop the ElementResizeObserver sends to the render function. | |
SearchBoxProps | Properties for SearchBox component | |
SettingsContainerProps | ||
SettingsProvidersChangedEventArgs | Arguments of onSettingsProvidersChanged event. | |
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 | |
SvgPathProps | Properties of SvgPath component. | |
TabLabel | TabLabel provides ability to define label, icon, and tooltip for a tab entry. | |
TabsProps | Properties for the VerticalTabs component | |
TextProps | Properties for various text components | |
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 | |
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 | ||
ExecuteHandler | ||
GetAutoSuggestDataFunc | ||
IconSpec | Prototype for an IconSpec which can be a string, ReactNode or ConditionalStringValue. | |
Types for message | ||
NodeCheckboxRenderer | ||
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 | |
StepFunctionProp | Step function prototype for NumberInput component |
Last Updated: 18 August, 2023