Adds @playcanvas/react docs #768
Merged
+784
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation and interactive examples for the new @playcanvas/react package. It updates styling, introduces an interactive example component, adjusts dependencies and webpack configuration, and provides detailed guides in the documentation.
- Adds new SCSS styling for interactive demos.
- Introduces a new PlayCanvas React example component.
- Updates package.json, Docusaurus config, and adds new documentation pages.
Reviewed Changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/css/custom.scss | New CSS classes for layout and interactive demo effects. |
| src/components/playcanvas-react-example.jsx | A new interactive component example using @playcanvas/react. |
| package.json | Adds dependencies for @playcanvas/react and raw-loader. |
| docusaurus.config.js | Updates webpack configuration to handle .m?js files. |
| docs/user-manual/playcanvas-react/index.mdx | New documentation page for PlayCanvas React overview and examples. |
| docs/user-manual/playcanvas-react/building-a-scene.md | A detailed guide for building a 3D scene with PlayCanvas React. |
…/developer.playcanvas.com into feat-playcanvas-react
Co-authored-by: Copilot <[email protected]>
- Introduced lazy loading for the PlayCanvas React example component to improve performance. - Updated the documentation to reflect the changes, including the use of BrowserOnly for the demo tab. - Removed the GitHub icon image as it is no longer needed. - Added external dependency for canvas-confetti in the Docusaurus config.
…/developer.playcanvas.com into feat-playcanvas-react
willeastcott
requested changes
Jun 3, 2025
willeastcott
reviewed
Jun 3, 2025
- Removed unused path import from docusaurus.config.js. - Updated building-a-scene.md to include a link to Web Components for clarity. - Enhanced index.mdx by specifying that PlayCanvas React provides built-in powerful features without third-party libraries, and updated links for better navigation.
|
This is ready for another review @willeastcott pls 🙏 |
willeastcott
approved these changes
Jun 24, 2025
- Removed custom Webpack configuration from docusaurus.config.js. - Updated @playcanvas/react to version 0.5.0 and added canvas-confetti as a dependency. - Adjusted import statement in playcanvas-react-example.jsx to use canvas-confetti from npm instead of ESM. - Modified building-a-scene.md to use a function for rendering LazyInteractive component.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds documentation for @playcanvas/react
I confirm I have read the contributing guidelines and signed the Contributor License Agreement.