API Reference › appui-react› State

State

Classes for maintaining state

Classes

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

Constants

Name Description  
ConfigurableUiActions An object with a function that creates each ConfigurableUiReducer that can be handled by our reducer. Deprecated
ReducerRegistryInstance ReducerRegistryInstance singleton instance of Reducer Registry Deprecated
SessionStateActions An object with a function that creates each SessionStateReducer that can be handled by our reducer. Deprecated
sessionStateMapDispatchToProps Object that contains available actions that modify SessionState. Deprecated
SYSTEM_PREFERRED_COLOR_THEME System preferred color theme.  
TOOLBAR_OPACITY_DEFAULT The default widget opacity.  
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. Deprecated
SessionStateActionId Action Ids used by Redux and to send sync UI components. Deprecated

Global Functions

Name Description  
combineReducers Turns an object whose values are different reducer functions, into a single Deprecated
ConfigurableUiReducer Handles actions to update ConfigurableUiState. Deprecated
connectIModelConnection Function that will connect a component to the IModelConnection data in the Redux store. Deprecated
connectIModelConnectionAndViewState Function that will connect a component to the IModelConnection data in the Redux store Deprecated
createAction Creates a basic Redux Redux Action with a payload value. Deprecated
FrameworkReducer Framework reducer that combines the ConfigurableUiReducer and SessionStateReducer. Deprecated
SessionStateReducer Handles actions to update SessionState. Deprecated
ThemeManager ThemeManager handles setting color themes and element opacity management.  

Interfaces

Name Description  
Action A basic Redux Action.  
ActionCreatorsObject Just an object where every property is a Redux Action Creator. Deprecated
ActionWithPayload A Redux Action, with additional "payload" information.  
ConfigurableUiState The portion of state managed by the ConfigurableUiReducer. Deprecated
CursorMenuData Definition of data added to Redux store to define cursor menu. Deprecated
CursorMenuPayload Definition of a cursor menu.  
FrameworkRootState Generic 'root' state for the appui-react package. Deprecated
FrameworkState Interface combining all the Framework state interfaces. Deprecated
NameToReducerMap NameToReducerMap used by Reducer Registry Deprecated
PresentationSelectionScope PresentationSelectionScope holds the id and the localized label for a selection scope supported for a specific iModel. Deprecated
SessionState The portion of state managed by the SessionStateReducer. Deprecated
SessionStateActionsProps An interface that allows redux connected object to dispatch changes to the SessionState reducer. Deprecated

Type Aliases

Name Description  
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 So we don't actually need to implement our own version of combineReducers, but we are going to cast it Deprecated
ConfigurableUiActionsUnion Union of ConfigurableUi Redux actions Deprecated
DeepReadonly Similar to the built-in Readonly, type alias but applied recursively.  
DeepReadonlyArray TypeScript doesn't actually allow recursive type aliases, so these are just sort of a hack to make DeepReadonly work  
DeepReadonlyObject TypeScript doesn't actually allow recursive type aliases, so these are just sort of a hack to make DeepReadonly work  
FunctionType Shorthand for "any function". Deprecated
Reducer A Redux 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 Deprecated
StateType A TypeScript type alias that represents the return type of a Redux Reducer.  
ThemeId Describe valid themes.  

Last Updated: 17 June, 2024