docs: update README with viewport-based lazy loading example and event type clarification #709
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
…t type clarification
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
colepeters
reviewed
Jan 14, 2026
Comment on lines
+499
to
+502
| projection: '{ title, excerpt }', | ||
| }) | ||
|
|
||
| return <div ref={ref}>{data?.title}</div> |
Member
There was a problem hiding this comment.
May wanna leave off the excerpt if it's not used?
Member
Author
There was a problem hiding this comment.
Showing the ref is the important part of this example, so I wanted to how where it came from.
Member
There was a problem hiding this comment.
Sorry I mean excerpt from the projection — it's not used in the example code, right?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
This PR updates the React SDK documentation in two ways:
Updates the event type names in the
useDocumentEventexample to match the actual event types returned by the API (edited,published,deleted, etc. instead ofdocumentEdited,documentPublished, etc.)Adds a new section demonstrating viewport-based lazy loading with
useDocumentProjectionusing a ref to only fetch content when an element becomes visible in the viewportWhat to review
useDocumentEventexample are correctTesting
Documentation changes only, no functional changes to test.
Fun gif