IFluidReducerProps Interface

Packages > @fluidframework/react > IFluidReducerProps

Props passed in to the useReducerFluid hook

Signature:

export interface IFluidReducerProps<SV extends IViewState, SF extends IFluidState, A extends IFluidReducer<SV, SF, C>, B, 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 TODO: Move data props out as it can be fetched from synced Fluid data object but still needs to be extensible for reducers
reducer A The Fluid reducer containing all the functions as defined by an extension of the IFluidReducer type. Any mutations to the state, or effects outside of the Fluid object involving the state should be done here.
selector B The Fluid selector containing all the functions as defined by an extension of the IFluidSelector type. Any fetching of new Fluid objects or data from other Fluid objects should be done here.
syncedDataObject SyncedDataObject An instance of the SyncedDataObject that this will be rendered in
syncedStateId string Unique ID to use for storing the view's synced state in the SyncedDataObject's syncedState SharedMap

Events

dataProps

Data props that are loaded in during the Fluid initialization step. This contains the runtime and the Fluid object map TODO: Move data props out as it can be fetched from synced Fluid data object but still needs to be extensible for reducers

Signature:

dataProps?: C;

reducer

The Fluid reducer containing all the functions as defined by an extension of the IFluidReducer type. Any mutations to the state, or effects outside of the Fluid object involving the state should be done here.

Signature:

reducer: A;

selector

The Fluid selector containing all the functions as defined by an extension of the IFluidSelector type. Any fetching of new Fluid objects or data from other Fluid objects should be done here.

Signature:

selector: B;

syncedDataObject

An instance of the SyncedDataObject that this will be rendered in

Signature:

syncedDataObject: SyncedDataObject;

syncedStateId

Unique ID to use for storing the view’s synced state in the SyncedDataObject’s syncedState SharedMap

Signature:

syncedStateId: string;