ISyncedStateConfig Interface

Packages > @fluidframework/react > ISyncedStateConfig

Signature:

export interface ISyncedStateConfig<SV, SF> 

Properties

List of properties of this interface
Property Type Description
defaultViewState SV The backup default view that any view with this ID will use prior to Fluid state initializing, this can be overridden by the view developer themselves
fluidToView FluidToViewMap A map of the Fluid state values that need conversion to their view state counterparts and the respective converters
syncedStateId string Unique ID to use for storing the view's synced state in the SyncedDataObject's syncedState SharedMap
viewToFluid ViewToFluidMap A map of the view state values that need conversion to their Fluid state counterparts and the respective converters

Events

defaultViewState

The backup default view that any view with this ID will use prior to Fluid state initializing, this can be overridden by the view developer themselves

Signature:

defaultViewState: SV;

fluidToView

A map of the Fluid state values that need conversion to their view state counterparts and the respective converters

Signature:

fluidToView: FluidToViewMap<SV, SF>;

syncedStateId

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

Signature:

syncedStateId: string;

viewToFluid

A map of the view state values that need conversion to their Fluid state counterparts and the respective converters

Signature:

viewToFluid?: ViewToFluidMap<SV, SF>;