ICombinedState Interface

Packages > @fluidframework/react > ICombinedState

The combined state contains the Fluid and view states and the data props that are passed in to all reducers and selectors

Signature:

export interface ICombinedState<SV extends IViewState, SF extends IFluidState, C extends IFluidDataProps> 

Properties

List of properties of this interface
Property Type Description
dataProps C Data props that are loaded in during the Fluid initialization step. This contains the runtime and the Fluid object map, along with any other properties the user wants to pass to reducers and selectors
fluidState SF The Fluid state that will be used to update the synced values in the state. This will be undefined until it is initialized, after which the state will update with the defined values
viewState SV The react view state that will be used for all view renders

Events

dataProps

Data props that are loaded in during the Fluid initialization step. This contains the runtime and the Fluid object map, along with any other properties the user wants to pass to reducers and selectors

Signature:

dataProps: C;

fluidState

The Fluid state that will be used to update the synced values in the state. This will be undefined until it is initialized, after which the state will update with the defined values

Signature:

fluidState?: SF;

viewState

The react view state that will be used for all view renders

Signature:

viewState: SV;