generated from chiffre-io/template-library
-
-
Notifications
You must be signed in to change notification settings - Fork 75
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: Introducing adapters for other frameworks #644
Draft
franky47
wants to merge
31
commits into
v2/release
Choose a base branch
from
feat/adapters
base: v2/release
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+7,565
−501
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
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
commit: |
franky47
force-pushed
the
v2/release
branch
from
September 24, 2024 20:48
b7d5bda
to
be08a7c
Compare
franky47
force-pushed
the
feat/adapters
branch
from
September 24, 2024 20:49
0cea654
to
ba555b5
Compare
franky47
force-pushed
the
v2/release
branch
from
September 28, 2024 05:56
be08a7c
to
972ec59
Compare
franky47
force-pushed
the
feat/adapters
branch
from
September 28, 2024 05:57
6fc566b
to
cb73eca
Compare
franky47
force-pushed
the
feat/adapters
branch
from
October 3, 2024 22:23
cb73eca
to
9241aa6
Compare
It pulls in a ton of dependencies for React Native, slowing the CI build down. Since it's a very new framework, showcasing how to support it can be moved to documentation on custom adapters, as it's a fairly simple integration.
franky47
force-pushed
the
feat/adapters
branch
from
October 11, 2024 19:31
c05604a
to
5facf6b
Compare
BREAKING CHANGE: When using Next.js, nuqs v2 requires next@>=14.2.0. Initially this was going to be >=14.1.2, but a bug fix in vercel/next.js#61419 that landed in 14.2.0 makes it that 14.1.{2,3,4} would require copying the ReadOnlyURLSearchParams returned by useSearchParams to conform to the adapters API.
Always test against Next.js releases that introduced changes in the app router core, but not all the intermediary ones. The stricter set can be tested on merge to next, before deployments, and manually when using the uncached `ci` branch.
Don't test those at all in regular cases.
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.
Tasks
Add docs on adapters in Fumadocs
Add/update docs on testing showcasing the
NuqsTestingAdapter
Add docs on adapters in the readme
Update migration docs
Expose adapters API for users to create their own (marked as unstable in v2, stabilised after gathering feedback)
Remove the adapter for OneJS, as it pulls in a ton of dependencies for RN. It's simple enough to be a copy-pasta example integration to showcase the custom adapters API.
idea: Should the React adapter provide initial search params on the server for custom SSR implementations?-> Not on this version, can be an improvement later.Add docs on how to create adapters (for external contributions)-> can be done in a later time as it's all experimentalBreaking changes
nuqs now requires wrapping your app with a
NuqsAdapter
(see below), which is a context provider connecting your framework APIs to the hooks' internals.The
startTransition
option no longer automatically setsshallow: false
.The
Options
type is no longer generic.The
"use client"
directive was not included in the client import (import {} from 'nuqs'
). It has now been added, meaning that server-side code needs to import fromnuqs/server
to avoid errors like:Adapters
You'll need to wrap your application in a
NuqsAdapter
, as such:Next.js, app router:
Next.js, pages router:
The main reason for adapters is to open up nuqs to other React frameworks:
Vanilla React (eg: with Vite):
Remix:
React Router:
Closes #603, #620.