# @fluidframework/react Utilities for integrating content powered by the Fluid Framework into [React](https://react.dev/) applications. This package currently has some experimental APIs focused on integrating SharedTree content into React. ## Known Issues and Limitations This package is currently ESM only and does not support CommonJS. These are a mix of issues that were encountered when authoring this package, as well as limitations of this package. Some of this logic would be useful for non-react applications: to avoid creating even more septate packages, that logic is not split into its own package. If there is clear demand for this to be done, it might be done in the future. There is no service implementation agnostic client abstraction that can be referred to here (ex: shared by TinyliciousClient, AzureClient and OdspClient). This makes documenting compatibility with that implicit common API difficult. It also makes writing service agnostic code at that abstraction level harder. There does not appear to be a local service implementation of the above mentioned abstraction, which makes testing the code in the package harder. The commonly used boilerplate for setting up a ContainerSchema based application configures the dev-tools, but currently can't be included in this package due to dependency layering issues. ## 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. ## Installation Run this command to install the package: ```bash npm i @fluidframework/react ``` ## Importing from this package This package uses [package.json exports](https://nodejs.org/api/packages.html#exports) to separate APIs by support level. For information about the support guarantees, read [API Support Levels](https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels). Import the `public` APIs from `@fluidframework/react`. Import the `beta` APIs from `@fluidframework/react/beta`. Import the `alpha` APIs from `@fluidframework/react/alpha`. ## API Documentation Read the **@fluidframework/react** API documentation at . ## Minimum Client Requirements Fluid Framework client libraries support the platforms in this document. These requirements are intentionally restrictive. Within a major version series, we can relax these requirements, but we cannot make them stricter. For a Long Term Support (LTS) version, we might need to support these platforms for several years. Other configurations can work, but Fluid Framework does not support them. If an unsupported configuration stops working, we do not classify this as a bug. To request support for a configuration that is not listed, file an issue. The product team will evaluate your request. In the issue, specify the current status of the configuration: - The configuration works but needs official support. - The configuration does not work and requires changes. ### Supported Runtimes - Fluid Framework supports Node.js versions 22 and 24 while they receive [upstream support](https://nodejs.org/en/about/previous-releases). - Fluid Framework will stop support for version 22 [when upstream support ends on 2027-04-30](https://github.com/nodejs/release#release-schedule). - Fluid Framework does not support Node.js with the `--no-experimental-fetch` flag. - Fluid Framework supports modern browsers that support the ES2022 standard library. ### Supported Tools - [TypeScript 6.0](https://typescriptdocs.com/release-notes/TypeScript%206.0): - Fluid Framework supports all [`strict`](https://www.typescriptlang.org/tsconfig) options. - Set the build targets (`lib`, `target`) to `ES2022` or later. - Enable [`strictNullChecks`](https://www.typescriptlang.org/tsconfig). - Fluid Framework does not support [configuration options deprecated in TypeScript 6.0](https://typescriptdocs.com/release-notes/TypeScript%206.0#breaking-changes-and-deprecations-in-typescript-6-0). - Fluid Framework does not fully support `exactOptionalPropertyTypes`. If you enable this option, do not use `in`, `Reflect.has`, `Object.hasOwn`, or `Object.prototype.hasOwnProperty` to narrow members of Fluid Framework types. These methods can incorrectly exclude `undefined` from the possible values. - [webpack](https://webpack.js.org/) 5 - We do not require a specific bundler. Other bundlers that handle ES Modules can work, but we actively test only webpack. ### Module Resolution In TypeScript `compilerOptions`, use [`Node16`, `Node20`, `NodeNext`, or `Bundler`](https://www.typescriptlang.org/tsconfig#moduleResolution) module resolution. These settings follow the [Node.js v12+ ESM Resolution and Loading algorithm](https://nodejs.github.io/nodejs.dev/en/api/v20/esm/#resolution-and-loading-algorithm). Do not use `Node10` module resolution. ### Module Formats - ES Modules: Use ES Modules to consume Fluid Framework client packages, including in Node.js. - CommonJS: Fluid Framework does not officially support CommonJS in version 3.0 or later. ## Contribution Guidelines You can [contribute](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) to Fluid Framework in these ways: - Answer questions in [GitHub Discussions](https://github.com/microsoft/FluidFramework/discussions). - [Submit bug reports](https://github.com/microsoft/FluidFramework/issues) and help verify fixes. - Review [source code changes](https://github.com/microsoft/FluidFramework/pulls). - [Contribute bug fixes](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md). For detailed instructions, read the [repo documentation](https://github.com/microsoft/FluidFramework/blob/main/docs/content/Home.md). This project follows the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information, read the [Code of Conduct frequently asked questions](https://opensource.microsoft.com/codeofconduct/faq/). For questions or comments, contact . 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](https://www.microsoft.com/trademarks). Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. ## Help Read the [Fluid Framework documentation](https://fluidframework.com/docs/) for information about Fluid Framework concepts and APIs. To request information that the documentation does not contain, [create an issue](https://github.com/microsoft/FluidFramework/blob/main/docs/content/Contributing/Submitting-Bugs-and-Feature-Requests.md). ## 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](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general). Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.