ui-core

Classes

Name Description
Button Generic button component
Checkbox A React component that renders a simple checkbox with label
CheckListBox React component showing a list of Checkbox items. Beta
CheckListBoxItem Item with a checkbox added to a CheckListBoxItem.CheckListBox. Beta
ContextMenu A context menu populated with ContextMenu.ContextMenuItem components.
ContextMenuDivider Menu Divider for ContextMenuDivider.ContextMenu.
ContextMenuItem Menu Item class for use within a ContextMenuItem.ContextMenu component.
ContextSubMenu Submenu wrapper class for use within a ContextSubMenu.ContextMenu component.
Cube Cube React component used by the 3d Cube Navigation Aid Beta
Dialog Dialog React component with optional resizing and dragging functionality
ElementSeparator A movable button, which allows to change the ratio between left element and right element
ExpandableBlock ExpandableBlock is a React component that shows and hides child content.
ExpandableList ExpandableList React component
ExpansionToggle ExpansionToggle React component used by the ExpansionToggle.TreeNode component
FocusTrap Trap Focus in container while trap is active. Beta
GlobalContextMenu GlobalContextMenu React component used to display a GlobalContextMenu.ContextMenu at the cursor
GlobalDialog GlobalDialog React component used to display a GlobalDialog.Dialog on the top of screen
HorizontalTabs Horizontal tabs meant to represent the current position in a page/section Beta
ImageCheckBox ImageCheckBox React component shows a checked or unchecked image Beta
Input Basic text input
InputLabel Text input wrapper that provides additional styling and labeling
LabeledInput Text input wrapper that provides additional styling and labeling
LabeledSelect Dropdown wrapper that allows for additional styling and labelling
LabeledTextarea Textarea wrapper that allows for additional styling and labelling
LabeledToggle Toggle component with a Label to the right
LoadingBar A loading bar with optional percentage text. Beta
LoadingPrompt A component to display during loading. Beta
LoadingSpinner A loading spinner component. Beta
LoadingStatus A loading indicator that shows status text along with the percentage. Beta
LocalUiSettings Implementation of LocalUiSettings.UiSettings using Window.localStorage. Beta
MessageBox Message Box React component.
MessageContainer Message Container React component.
Popup Popup React component Beta
RadialButton Button for use within a RadialButton.RadialMenu Beta
RadialMenu A context menu arranged in a radial layout. Beta
Radio Basic radio input component
Input box with builtin icon right justified bounded by the SearchBox
Select Basic select component
SessionUiSettings Implementation of SessionUiSettings.UiSettings using Window.sessionStorage. Beta
Spinner A spinner component.
SplitButton SplitButton with a button on the left and a context menu on the right. Beta
SvgPath Svg element wrapper with specified Svg paths.
SvgSprite Svg element wrapper.
Tabs Tabs meant to represent the current position in a page/section Beta
Textarea Basic textarea component
Timer Notifies handler after a set interval.
Toggle Toggle React component to show an "on" or "off state
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 Entry point for static initialization required by various
UiEvent iModel.js UI UiEvent class is a subclass of BeEvent with argument type safety.
VerticalTabs Vertical tabs meant to represent the current position in a page/section Beta

Constants

Name Description
DivWithOutsideClick Div element with Outside Click behavior Beta
LEVEL_OFFSET Number of pixels the node gets offset per each hierarchy level
UiError iModel.js UI UiError class is a subclass of BentleyError. Deprecated

Enumerations

Name Description
ButtonSize Sizes for ButtonSize.Button component
ButtonType Types for ButtonType.Button component
CheckBoxState State of a checkbox
ContextMenuDirection Enum to specify where a ContextMenuDirection.ContextMenu should anchor to its parent element
DateFormat Enumeration of date formats.
DialogAlignment Enum for dialog alignment
DialogButtonStyle Enum for button style.
DialogButtonType Enum for button types.
Face Cube Face enumeration Beta
HorizontalAlignment Enumeration for horizontal alignment.
InputStatus Enum for Input status
MessageSeverity Message Severity enum.
Orientation Enumeration of orientation.
Position Position of the popup relative to its target Beta
SortDirection Enumeration for sorting direction.
SpinnerSize Size for SpinnerSize.Spinner component
TimeFormat Enumeration of time formats.
ToggleButtonType Toggle display types
UiSettingsStatus Enum for UiSettingsStatus.UiSettings status. Beta
VerticalAlignment Enumeration for vertical alignment.

Global Functions

Name Description
BlockText Styled block text React functional component
BodyText Styled body text React functional component
Centered Centered React functional component
CheckListBoxSeparator Separator added to a CheckListBoxSeparator.CheckListBox. Beta
FillCentered Full height & width and centered React functional component
FlexWrapContainer Flex Wrap Container React functional component
Headline Styled headline text React functional component
Icon Icon Functional component
LeadingText Styled leading text React functional component
LeadingText2 Styled leading text React functional component
MutedText Styled muted/gray text React functional component
ScrollView Scroll View React functional component
SmallText Styled small text React functional component
Subheading Styled subheading text React functional component
Subheading2 Styled subheading text React functional component
Title Styled title text React functional component
Title2 Styled title text React functional component
UnderlinedButton A React component that makes text clickable and underlined
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
ButtonProps Properties for ButtonProps.Button component
CheckBoxInfo A data type that holds all the checkbox display attributes
CheckboxProps Properties for CheckboxProps.Checkbox React component
CheckListBoxItemProps Properties for the CheckListBoxItemProps.CheckListBoxItem component Beta
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 ContextMenuItemProps.ContextMenuItem component
ContextMenuProps Properties for the ContextMenuProps.ContextMenu component
ContextSubMenuProps Properties for the ContextSubMenuProps.ContextSubMenu component
CubeProps Properties for the CubeProps.Cube React component Beta
DialogButtonDef Interface for a dialog button in a button cluster
DialogProps Properties for the DialogProps.Dialog component
ElementSeparatorProps Properties of ElementSeparatorProps.ElementSeparator React component
ExpandableBlockProps Properties for the ExpandableBlockProps.ExpandableBlock React component
ExpandableListProps Properties for ExpandableListProps.ExpandableList component
ExpansionToggleProps Properties for the ExpansionToggleProps.ExpansionToggle component
GlobalContextMenuProps Properties for the GlobalContextMenuProps.GlobalContextMenu component
GlobalDialogProps Properties for the GlobalDialogProps.GlobalDialog component
IconProps Properties for the IconProps.Icon React component
ImageCheckBoxProps Properties for the ImageCheckBoxProps.ImageCheckBox component Beta
InputLabelProps Properties for InputLabelProps.InputLabel components
InputProps Properties for the InputProps.Input component
LabeledComponentProps Properties for labeled components
LabeledInputProps Properties for LabeledInputProps.LabeledInput components
LabeledSelectProps Properties for LabeledSelectProps.LabeledSelect components
LabeledTextareaProps Properties for LabeledTextareaProps.LabeledTextarea component
LabeledToggleProps Properties for LabeledToggleProps.LabeledToggle
LoadingBarProps Properties for LoadingBarProps.LoadingBar component Beta
LoadingPromptProps Properties for LoadingPromptProps.LoadingPrompt component Beta
LoadingSpinnerProps Properties for LoadingSpinnerProps.LoadingSpinner component Beta
LoadingStatusProps Properties for LoadingStatusProps.LoadingStatus component Beta
MainTabsProps Properties for the base MainTabsProps.Tabs component Beta
MessageBoxProps Properties for the MessageBoxProps.MessageBox component
MessageContainerProps Properties for the MessageContainerProps.MessageContainer component
MessagedComponentProps Properties for components with messages
NoChildrenProps Props used by components that do not expect children to be passed in. Beta
NodeCheckboxProps Properties for Tree Node CheckBox Beta
PointProps Describes 2d points. Beta
PopupProps Properties for the PopupProps.Popup component Beta
RadialButtonProps Properties for RadialButtonProps.RadialButton component Beta
RadialMenuProps Properties for RadialMenuProps.RadialMenu Beta
RadioProps Properties for RadioProps.Radio component
RectangleProps Describes 2d bounds. Beta
SearchBoxProps Properties for SearchBoxProps.SearchBox component
SelectProps Properties for SelectProps.Select component
SizeProps Describes 2d dimensions. Beta
SpinnerProps Properties for SpinnerProps.Spinner component
SplitButtonProps Properties for SplitButtonProps.SplitButton component Beta
SvgPathProps Properties of SvgPathProps.SvgPath component.
SvgSpriteProps Properties of SvgSpriteProps.SvgSprite component.
TabsProps Properties for the TabsProps.HorizontalTabs and TabsProps.VerticalTabs components Beta
TextareaProps Properties for TextareaProps.Textarea component
TextProps Properties for various text components
ToggleProps Properties for ToggleProps.Toggle component
TreeBranchProps Properties for TreeBranchProps.TreeBranch React component
TreeNodePlaceholderProps Properties for the TreeNodePlaceholderProps.TreeNodePlaceholder React component
TreeNodeProps Properties for the TreeNodeProps.TreeNode React component
TreeProps Properties for the TreeProps.Tree presentational React component
UiSettings Interface for getting, saving and deleting settings. Beta
UiSettingsResult Interface for UiSettingsResult.UiSettings result. Beta
UnderlinedButtonProps Properties for the UnderlinedButtonProps.UnderlinedButton React component
WebFontIconProps Properties for the WebFontIconProps.WebFontIcon React component
WithIsPressedProps Properties for WithIsPressedProps.withIsPressed React higher-order component
WithOnOutsideClickProps Properties for WithOnOutsideClickProps.withOnOutsideClick React higher-order component
WithTimeoutProps Properties for WithTimeoutProps.withTimeout React higher-order component

Type Aliases

Name Description
ExecuteHandler Signature for ExecuteHandler.Timer execute callback.
IconSpec Prototype for an IconSpec which can be a string or a ReactNode.
NodeCheckboxRenderer Type for node checkbox renderer Beta
NodeCheckboxRenderProps Props for node checkbox renderer Beta
Omit Used to omit properties in a given interface
OmitChildrenProp Omit children property from T. Beta

Last Updated: 24 January, 2020