microsoft /FluidFramework
Library for building distributed, real-time collaborative web applications
★ 4,949⑂ 591👁 70⑃ 25,195● 3,419▤ 299
+0
日增长
4,949
stars
591
forks
70
watchers
25,195
prs
3,419
issues
299
releases
README
Fluid
The Fluid Framework is a library for building distributed, real-time collaborative web
applications using JavaScript or TypeScript.
Getting started using the Fluid Framework
You may be here because you want to...
- Learn more about the Fluid Framework
- Build a Fluid object
Documentation and guides can be found at .
Hello World repo can be found at .
Core Examples repo can be found at .
Have questions? Engage with other Fluid Framework users and developers in the Discussions section of our GitHub repo.
Using Fluid Framework libraries
For a dependency on a Fluid Framework library's public APIs, we recommend a ^ (caret) version range.
For example, use ^1.3.4.
For a dependency on an unstable API, such as a beta API, we recommend a more restrictive version range.
For example, use a ~ version range.
Code structure
The core code for both the Fluid client packages _and_ the reference ordering service is contained within this repo.
The repo structure is somewhat unique because it contains several pnpm workspaces:
some for individual packages and some for larger collections which we call "release groups".
The workspaces are versioned separately from one another, but internally all packages in a workspaces are versioned together.
These workspaces do not align with package namespaces, and also don't always correspond to a single directory of this repo.
Here's the list of release group workspaces:
- client (previously known as "Fluid Framework Client" or "core") (Rooted in ./. Configured by ./pnpm-workspace.yaml)
- ./packages (Published in the @fluidframework/ namespace, but some in @fluid-tools and unpublished packages in @fluid-internal/)
- ./experimental (Published in the @fluid-experimental/ namespace)
- ./examples (Not published, live in the @fluid-example/ namespace)
- ./azure. (Published in the @fluidframework/ namespace)
- routerlicious (Reference Fluid Ordering Service) (Rooted in ./server/routerlicious. Configured by ./server/routerlicious/pnpm-workspace.yaml)
- Packages (Published in the @fluidframework/ namespace)
- gitrest (Rooted in ./server/gitrest. Configured by ./server/gitrest/pnpm-workspace.yaml)
- Packages (Published in the @fluidframework/ namespace)
- historian (Rooted in ./server/historian. Configured by ./server/historian/pnpm-workspace.yaml)
- Packages (Published in the @fluidframework/ namespace)
- build-tools (Rooted in ./build-tools. Configured by ./build-tools/pnpm-workspace.yaml)
- Packages (Published in a mix of @fluidframework/ and @fluid-tools/ namespaces)
Here's a list of other sets of other packages (each package within these groups is versioned independently,
forming its own release group):
- "Common" Packages: miscellaneous packages in the ./common directory and published under the @fluidframework/ namespace. Most of these (but not all) have "common" in their package name.
Packages which are used by multiple other groupsTop issues
#26758[aw] No-Op Runs30 comments · 2026-03-17#26464[agentics] No-Op Runs26 comments · 2026-02-17#4683Snapshot, summary, Tree entries: Need standardization and reduction of concepts.11 comments · 2020-12-23#26972[aw] Code Simplifier failed (pre-agent)9 comments · 2026-04-08#24450Removal of `Loader` class3 comments · 2025-04-24#28498tree: allowed types given as a readonly array (not a tuple) make a field accept no values2 comments · 2026-10-21#26284SharedObject and SharedObjectCore will removed in v3.20.02 comments · 2026-01-26#28499tree: adaptEnum's schema type is slow to type-check for large enums1 comments · 2026-10-21
Discussions
#28457End of life in 4 months0 comments · 2026-10-15#27606Is uploadBlob the right way to share large binary (300+ MB) in Fluid 2.x, and why is it marked @legacy, or is there a better way?0 comments · 2026-06-25#26827Is anyone other than Microsoft using FluidFramework in production?0 comments · 2026-03-25#25826Co-authoring using the latest version of the Microsoft Fluid Framework within an SPFx web part0 comments · 2025-11-06#25589How do I stop errors getting logged in the browser when the auth token expires?0 comments · 2025-10-01#25354How to tell at which array index a new element was added at an event handler for an array node in a SharedTree DDS?1 comments · 2025-09-02#24998How to access the SharedTree object on backend ?2 comments · 2025-07-10#24972How to clone objectRecursive object from schema factory?1 comments · 2025-07-06
Latest release
Fluid Framework v3.12.0 (minor) client_v3.12.0 2026-11-10Contents - ✨ New Features - Add controls to pause inbound operations while staging local changes (28625) - 🌳 SharedTree DDS Changes - Array move events now behave consistently before and after hydration (28487) - Manage branch state independently of views (28520) - Reduce optimized forest memory overhead after loading and receiving inserted content (28653) - ⚠️ Deprecations - Deprecate isEquivalent compatibility flag (28655) ✨ New Features Add controls to pause inbound operations while staging local changes (28625) The beta stage controls expose pauseInbound() and resumeInbound