Skip to content

Latest commit

 

History

History

data-object-grid

README.md

@fluid-example/data-object-grid

Data object grid is a Fluid component that provides a grid layout for users to compose their own experiences by adding and re-arranging data objects. This example explores how modular document types could work in Fluid.

Getting Started

Complete these steps to run the example:

  1. Run corepack enable to enable Corepack.
  2. From the FluidFramework root directory, run pnpm install.
  3. From the FluidFramework root directory, run pnpm run build:fast --nolint.
    • To build only this package, add the package name to the command: pnpm run build:fast --nolint @fluid-example/data-object-grid
  4. In a separate terminal, run pnpm tinylicious from this directory to start Tinylicious.
  5. If you use GitHub Codespaces in a browser, set the visibility of the Tinylicious port (7070) to public. Do not use Private to Organization. For instructions, read Sharing a port.
  6. Run pnpm start from this directory.
  7. Open http://localhost:8080 in a web browser.

To run the example with SharePoint, complete these steps:

  1. Follow the webpack-fluid-loader instructions to get authentication credentials.
  2. Run pnpm start:spo or pnpm start:spo-df from this directory.
  3. Open http://localhost:8080 in a web browser.

Data objects

The data-object-grid package pulls in a collection of outside data objects into a registry that enables creation and constructing views. This isolates the knowledge of how to create and render the data objects away from the core application, and makes it extensible to further data object types.

Contribution Guidelines

You can contribute to Fluid Framework in these ways:

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.

Help

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.

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.