Skip to content

Latest commit

 

History

History
 
 

fluid-static

@fluidframework/fluid-static

The fluid-static package provides a simple and powerful way to consume collaborative Fluid data.

Using Fluid Framework libraries

When taking a dependency on a Fluid Framework library, we recommend using a ^ (caret) version range, such as ^1.3.4. While Fluid Framework libraries may use different ranges with interdependencies between other Fluid Framework libraries, library consumers should always prefer ^.

Note that when depending on a library version of the form 2.0.0-internal.x.y.z, called the Fluid internal version scheme, you must use a >= < dependency range. Standard ^ and ~ ranges will not work as expected. See the @fluid-tools/version-tools package for more information including tools to convert between version schemes.

Using fluid-static

The fluid-static package contains a container with a pre-created default data object with the ability to create and store additional objects. This is abstracted behind a developer-friendly FluidContainer interface that provides configurations for defining the container's initial object and supported dynamic object types, as well as callbacks for creating and fetching DDSes and data objects.

This is consumed by separate client packages, such as TinyliciousClient for the Tinylicious service, to provide an easy way of creating and fetching FluidContainer instances that are backed by data stored on the respective services.

Trademark

This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.

Use of these trademarks or logos must follow Microsoft's Trademark & Brand Guidelines.

Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.