This package contains simplified driver implementations used by Fluid examples in the FluidFramework repo. These may only be used in the examples, and are not intended for use in production scenarios.
To use this package in an example, you must first integrate the @fluid-example/example-webpack-integration package as described in its README. Then follow these steps:
- When constructing your driver, first call
getSpecifiedServiceFromWebpack()to determine the requested service (one of"t9s","odsp", or"local"). - Then call
createExampleDriver(service)using the value obtained from 1. This will return anExampleDriver. - Use the
ExampleDriver'surlResolveranddocumentServiceFactorydirectly in your calls tocreateDetachedContainer()andloadExistingContainer(). - Use the
ExampleDriver'screateCreateNewRequest(id)to generate anIRequestfor yourcontainer.attach(request)call. Provide it with a unique id.- If you are using the odsp service, the passed id will be used when loading the container in the future. Otherwise, inspect the
container.resolvedUrl.idafter attach has completed to discover the container id to use for loading.
- If you are using the odsp service, the passed id will be used when loading the container in the future. Otherwise, inspect the
- Use the
ExampleDriver'screateLoadExistingRequest(id)to generate anIRequestfor yourloadExistingContainer()call. Note thatcreateLoadExistingRequestreturns aPromise<IRequest>and must beawaited.
See GitHub for more details on the Fluid Framework and packages within.
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.