feat: Full-page navigation option for shallow: false updates in React SPA

[franky47]

This allows using the React SPA adapter with a backend server catching the search param updates configured with shallow: false. For example, this can be useful when paired with a server written in other languages than JavaScript: Rails, Laravel, Django, Phoenix etc, that serves a statically built React SPA bundle.

It's disabled by default to keep compatibility with existing code (where shallow: false doesn't do anything), but it might be switched on by default in nuqs@3.0.0 (TBC).

Usage

import { NuqsAdapter } from 'nuqs/adapters/react'
import { createRoot } from 'react-dom/client'

createRoot(document.getElementById('root')!).render(
  <NuqsAdapter fullPageNavigationOnShallowFalseUpdates>
    <App />
  </NuqsAdapter>
)

Tasks

• Add e2e test (might require matricing the e2e-react job)
• Add docs
• Update the branch protection before merging
• Do a test with Django or Phoenix

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
nuqs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 17, 2025 10:26am

[pkg-pr-new]

pnpm add https://pkg.pr.new/nuqs@891

commit: c475b13

[github-actions]

🎉 This PR is included in version 2.4.0-beta.6 🎉

The release is available on:

• npm package (@beta dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[github-actions]

🎉 This PR is included in version 2.4.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀