IFluidProps Interface

Packages > @fluidframework/react > IFluidProps

Props passed in to create a FluidReactView or passed in to the useStateFluid hook

Signature:

export interface IFluidProps<SV extends IViewState, SF extends IFluidState> 

Properties

List of properties of this interface
Property Type Description
dataProps IFluidDataProps Data props containing the Fluid object map and the runtime Optional as the above two will be passed by default. This only need to be defined if there are additional values from the Fluid object lifecycle that need to be made available to the reducers
syncedDataObject SyncedDataObject An instance of the SyncedDataObject that this view will be rendered in
syncedStateId string Unique ID to use for storing the synced state in the SyncedDataObject's syncedState SharedMap

Events

dataProps

Data props containing the Fluid object map and the runtime Optional as the above two will be passed by default. This only need to be defined if there are additional values from the Fluid object lifecycle that need to be made available to the reducers

Signature:

dataProps?: IFluidDataProps;

syncedDataObject

An instance of the SyncedDataObject that this view will be rendered in

Signature:

syncedDataObject: SyncedDataObject;

syncedStateId

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

Signature:

syncedStateId: string;