Minimal sample demonstrating use of the SharedTree API for collaborative text editing with Quill.
Complete these steps to run the example:
- Run
corepack enableto enable Corepack. - From the
FluidFrameworkroot directory, runpnpm install. - From the
FluidFrameworkroot directory, runpnpm run build:fast --nolint.- To build only this package, add the package name to the command:
pnpm run build:fast --nolint @fluid-example/text-editor
- To build only this package, add the package name to the command:
- Run
pnpm startfrom this directory and open http://localhost:8080 in a web browser. The app uses a session-storage-backed in-browser service by default and stores the container ID in the URL hash. - To select the session-backed service explicitly, run
pnpm start:sessionand open http://localhost:8080/?fluidClient=session. - To share data between browser sessions, start Tinylicious in a separate terminal by running
pnpm tinyliciousin this directory, then runpnpm start:tinyliciousand open http://localhost:8080/?fluidClient=tinylicious. If you use GitHub Codespaces in a browser, set the visibility of the Tinylicious port (7070) topublic. Do not usePrivate to Organization. For instructions, read Sharing a port.
Run the in-memory React component tests with Mocha:
pnpm test:mochaRun the service-backed browser tests with Playwright:
pnpm test:playwrightPlaywright starts Tinylicious and the webpack development server. If Tinylicious is already listening on port 7070, Playwright reuses that server. The tests cover the default session service, explicit session and ephemeral services, and Tinylicious. Each test creates a new Fluid document. A collaboration test opens each additional page in a separate browser context. Playwright closes the additional contexts after the test.
You can contribute to Fluid Framework in these ways:
- Answer questions in GitHub Discussions.
- Submit bug reports and help verify fixes.
- Review source code changes.
- Contribute bug fixes.
For detailed instructions, read the repo documentation.
This project follows the Microsoft Open Source Code of Conduct. For more information, read the Code of Conduct frequently asked questions. For questions or comments, contact opencode@microsoft.com.
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.
Read the Fluid Framework documentation for information about Fluid Framework concepts and APIs.
To request information that the documentation does not contain, create an issue.
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.