Enhance SplatViewer and documentation updates #135
Merged
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
- Introduced new `Check` and `Dash` components for improved UI feedback in the SplatViewer documentation. - Updated `registry-mdx-components` to include new components and adjusted imports for better organization. - Enhanced the `SplatViewer` component with new controls and improved camera functionality. - Updated `package.json` to streamline the build process by chaining the `postbuild` command with `registry:build`. - Revised documentation to reflect the latest features and improvements, including new API references and usage examples. These changes enhance the user experience and provide clearer guidance for developers using the SplatViewer component.
commit: |
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the SplatViewer component and its documentation by adding new features, components, and improvements to the underlying animation and camera controls while updating registry metadata and MDX components. Key changes include:
- The introduction of new Check and Dash UI components for documentation.
- Updates to SplatViewer and SmartCamera components, including the new autoPlay and onTypeChange options as well as improved styling and animation functionality.
- Adjustments to registry and MDX components for better organization and clearer API references.
Reviewed Changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/docs/registry/splat-viewer/utils/style.ts | Added a centralized style configuration (paris) for the viewer. |
| packages/docs/registry/splat-viewer/utils/animation.ts | Introduced a new rotation track creator and its associated type definitions. |
| packages/docs/registry/splat-viewer/splat-viewer.tsx | Updated the SplatViewer component to integrate SmartCamera, add autoPlay support, and clean up camera control props. |
| packages/docs/registry/splat-viewer/splat-viewer-context.tsx | Enhanced context provider with autoPlay defaults and expanded API documentation comments. |
| packages/docs/registry/splat-viewer/smart-camera.tsx | Added the SmartCamera component to handle interactive and animation modes using timeline subscriptions. |
| packages/docs/registry/splat-viewer/index.tsx | Reorganized exports to include new controls and timeline modules. |
| packages/docs/registry/splat-viewer/controls.tsx | Created a new Controls component with auto-hide functionality based on interaction state. |
| packages/docs/registry.json & packages/docs/public/r/*.json | Updated registry metadata to reflect new component names, homepage links, and versioning. |
| packages/docs/registry-mdx-components.tsx & packages/docs/mdx-components.js | Updated MDX component registrations to include the new Controls component and adjust import paths. |
| packages/docs/content/blocks.mdx | Refined demo content to showcase new features, autoPlay behavior, and Check/Dash component usage. |
| packages/docs/components/Check.tsx | Introduced Check and Dash components to visually indicate features in documentation. |
| packages/docs/package.json | Modified postbuild script to chain registry:build after pagefind processing. |
Comment on lines
172
to
173
|
|
||
| console.log('interactive camera', initialPose); |
There was a problem hiding this comment.
Remove or disable the debug log 'console.log('interactive camera', initialPose);' to avoid unintended console output in production.
Suggested change
| console.log('interactive camera', initialPose); | |
| if (process.env.NODE_ENV !== 'production') { | |
| console.log('interactive camera', initialPose); | |
| } |
Copilot uses AI. Check for mistakes.
Comment on lines
71
to
74
| /** | ||
| * Whether to automatically play the animation | ||
| */ | ||
| autoPlay?: boolean, |
There was a problem hiding this comment.
The 'autoPlay' property is declared in both SplatViewerComponentProps and in the combined SplatViewerProps; please consolidate these definitions to avoid redundancy and potential ambiguity.
Suggested change
| /** | |
| * Whether to automatically play the animation | |
| */ | |
| autoPlay?: boolean, | |
| // Removed redundant autoPlay property from SplatViewerProps |
Copilot uses AI. Check for mistakes.
| }) { | ||
| const entityRef = useRef<PcEntity>(null); | ||
| const { subscribe, isPlaying } = useTimeline(); | ||
| console.log('isPlaying', isPlaying); |
There was a problem hiding this comment.
Consider removing the debug log 'console.log('isPlaying', isPlaying);' to prevent unnecessary logging in production builds.
Suggested change
| console.log('isPlaying', isPlaying); |
Copilot uses AI. Check for mistakes.
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.
CheckandDashcomponents for improved UI feedback in the SplatViewer documentation.registry-mdx-componentsto include new components and adjusted imports for better organization.SplatViewercomponent with new controls and improved camera functionality.package.jsonto streamline the build process by chaining thepostbuildcommand withregistry:build.These changes enhance the user experience and provide clearer guidance for developers using the SplatViewer component.