feature: added useSuspenseQuery hook to react package
#353
Conversation
This file contains 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
🦋 Changeset detectedLatest commit: 4126515 The changes in this PR will be included in the next version bump. This PR includes changesets to release 4 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
rkistner
reviewed
Oct 16, 2024
rkistner
reviewed
Oct 16, 2024
|
LGTM |
DominicGBauer
previously approved these changes
Oct 16, 2024
Chriztiaan
force-pushed
the
react/suspense
branch
from
e2e68e2 to
c1f96ac
Compare
# Conflicts: # pnpm-lock.yaml
|
FYI @rkistner @DominicGBauer : I made a few changes to the PR so that the |
benitav
reviewed
Oct 17, 2024
stevensJourney
approved these changes
Oct 21, 2024
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.
This PR aims to introduce the
useSuspenseQueryhook to thereactpackage so that users can handle the loading state of a query with Suspense instead of the conventionalisLoading/isFetchingstate variables.The implementation is a minor variation of #100. The most noteworthy iterations are that it adds the suspense support under a separate hook to
useQuery, it supports queries that take longer than 5 seconds to complete, and compilable queries are accepted as possible input as well.As mentioned in the former PR, the state of the hook needs to be managed outside of the hook due to state being discarded while a component is suspended. This means that state is cached based on a
query-parameters-optionskey which means multiple hook invocations on the same would resolve to the same query. Note that the state for a given key is disposed when the hook is destroyed, but this opens the door for potential future work to add proper query caching to bothuseQueryanduseSuspenseQuery- with a proper interface for managing this cache (which is something that Tanstack supports really well).A few examples have been added to the package's README.md to illustrate how to handle typical cases when using Suspense, such as blocking navigation while the target page's components are suspending.