State

Classes for maintaining state

Classes

Name Description  
ReducerRegistry Redux Reducer Registry. Beta
StateManager Centralized state management class using Redux actions, reducers and store.  

Constants

Name Description  
COLOR_THEME_DEFAULT The default color theme. Deprecated
ConfigurableUiActions An object with a function that creates each ConfigurableUiReducer that can be handled by our reducer.  
ReducerRegistryInstance ReducerRegistryInstance singleton instance of Reducer Registry Beta
SafeAreaContext Context used to manage safe area (feature used by devices with non-rectangular screens).  
SessionStateActions An object with a function that creates each SessionStateReducer that can be handled by our reducer.  
sessionStateMapDispatchToProps Object that contains available actions that modify SessionState. Beta
SYSTEM_PREFERRED_COLOR_THEME System preferred color theme.  
ThemeManager ThemeManager handles setting color themes.  
WIDGET_OPACITY_DEFAULT The default widget opacity.  

Enumerations

Name Description  
ColorTheme Enum for the Color Theme string.  
ConfigurableUiActionId Action Ids used by Redux and to send sync UI components.  
SessionStateActionId Action Ids used by Redux and to send sync UI components.  

Global Functions

Name Description  
combineReducers Turns an object whose values are different reducer functions, into a single  
ConfigurableUiReducer Handles actions to update ConfigurableUiState.  
connectIModelConnection Function that will connect a component to the IModelConnection data in the Redux store.  
connectIModelConnectionAndViewState Function that will connect a component to the IModelConnection data in the Redux store Beta
createAction Creates a basic Redux Redux Action with a payload value.  
FrameworkReducer Framework reducer that combines the ConfigurableUiReducer and SessionStateReducer.  
SessionStateReducer Handles actions to update SessionState.  
withSafeArea HOC that injects SafeAreaInsets.  

Interfaces

Name Description  
Action A basic Redux Action.  
ActionWithPayload A Redux Action, with additional "payload" information.  
ConfigurableUiState The portion of state managed by the ConfigurableUiReducer.  
CursorMenuData Definition of data added to Redux store to define cursor menu.  
DeepReadonlyArray TypeScript doesn't actually allow recursive type aliases, so these are just sort of a hack to make DeepReadonly work  
FrameworkRootState Generic 'root' state for the ui-framework package. Beta
FrameworkState Interface combining all the Framework state interfaces.  
NameToReducerMap NameToReducerMap used by Reducer Registry  
PresentationSelectionScope PresentationSelectionScope holds the id and the localized label for a selection scope supported for a specific iModel.  
SessionState The portion of state managed by the SessionStateReducer.  
SessionStateActionsProps An interface that allows redux connected object to dispatch changes to the SessionState reducer. Beta

Type Aliases

Name Description  
ActionCreatorsObject Just an object where every property is a Redux Action Creator.  
ActionsUnion A TypeScript type alias that represents the Union Type of all actions  
ActionTypes A TypeScript type alias that uses conditional types (read: magic)  
CombinedReducerState A type alias which represents the state created by the reducer returned by combineReducers for a given reducers argument.  
CombineReducersFunction  
ConfigurableUiActionsUnion Union of ConfigurableUi Redux actions  
DeepReadonly Similar to the built-in Readonly, type alias but applied recursively.  
DeepReadonlyObject TypeScript doesn't actually allow recursive type aliases, so these are just sort of a hack to make DeepReadonly work  
FunctionType  
Reducer  
ReducerActions A TypeScript type alias that represents a union of all action types handled by a Redux Reducer.  
ReducerMapActions A type alias which represents the union type of all actions handled by the reducer returned by combineReducers for a given reducers argument.  
SessionStateActionsUnion Union of SessionState Redux actions  
StateType A TypeScript type alias that represents the return type of a Redux Reducer.  

Last Updated: 11 June, 2024