ref: Better name for the option

We're not doing a page reload, but a full page navigation.

Author: franky47

.github/workflows/ci-cd.yml

@@ -121,13 +121,13 @@ jobs:
           SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
 
   e2e-react:
-    name: E2E (react-reload-${{ matrix.reload-on-shallow-false }})
+    name: E2E (react-fpn-${{ matrix.full-page-nav-on-shallow-false }})
     runs-on: ubuntu-22.04-arm
     needs: [ci-core]
     strategy:
       fail-fast: false
       matrix:
-        reload-on-shallow-false: [false, true]
+        full-page-nav-on-shallow-false: [false, true]
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
       - uses: pnpm/action-setup@fe02b34f77f8bc703788d5817da081398fad5dd2
@@ -143,19 +143,19 @@ jobs:
           TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
           TURBO_TEAM: ${{ secrets.TURBO_TEAM }}
           E2E_NO_CACHE_ON_RERUN: ${{ github.run_attempt }}
-          RELOAD_ON_SHALLOW_FALSE: ${{ matrix.reload-on-shallow-false }}
+          FULL_PAGE_NAV_ON_SHALLOW_FALSE: ${{ matrix.full-page-nav-on-shallow-false }}
       - name: Save Cypress artifacts
         uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08
         if: failure()
         with:
           path: packages/e2e/react/cypress/screenshots
-          name: ci-react-reload-${{ matrix.reload-on-shallow-false }}
+          name: ci-react-fpn-${{ matrix.full-page-nav-on-shallow-false }}
       - uses: 47ng/actions-slack-notify@main
         name: Notify on Slack
         if: failure()
         with:
           status: ${{ job.status }}
-          jobName: react-reload-${{ matrix.reload-on-shallow-false }}
+          jobName: react-fpn-${{ matrix.full-page-nav-on-shallow-false }}
         env:
           SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
 

packages/docs/content/docs/adapters.mdx

@@ -94,9 +94,9 @@ updating query state configured with `shallow: false{:ts}`, to notify the web se
 that the URL state has changed, if it needs it for server-side rendering other
 parts of the application than the static React bundle:
 
-```tsx title="src/main.tsx" /reloadPageOnShallowFalseUpdates/
+```tsx title="src/main.tsx" /fullPageNavigationOnShallowFalseUpdates/
 createRoot(document.getElementById('root')!).render(
-  <NuqsAdapter reloadPageOnShallowFalseUpdates>
+  <NuqsAdapter fullPageNavigationOnShallowFalseUpdates>
     <App />
   </NuqsAdapter>
 )

packages/e2e/react/src/main.tsx

@@ -9,8 +9,8 @@ enableHistorySync()
 createRoot(document.getElementById('root')!).render(
   <StrictMode>
     <NuqsAdapter
-      reloadPageOnShallowFalseUpdates={
-        process.env.RELOAD_ON_SHALLOW_FALSE === 'true'
+      fullPageNavigationOnShallowFalseUpdates={
+        process.env.FULL_PAGE_NAV_ON_SHALLOW_FALSE === 'true'
       }
     >
       <RootLayout>

packages/e2e/react/vite.config.ts

@@ -11,8 +11,8 @@ export default defineConfig(({ mode }) => {
       sourcemap: true
     },
     define: {
-      'process.env.RELOAD_ON_SHALLOW_FALSE': JSON.stringify(
-        env.RELOAD_ON_SHALLOW_FALSE
+      'process.env.FULL_PAGE_NAV_ON_SHALLOW_FALSE': JSON.stringify(
+        env.FULL_PAGE_NAV_ON_SHALLOW_FALSE
       )
     }
   }

packages/nuqs/src/adapters/react.ts

@@ -15,11 +15,11 @@ import { patchHistory, type SearchParamsSyncEmitter } from './lib/patch-history'
 
 const emitter: SearchParamsSyncEmitter = mitt()
 
-function generateUpdateUrlFn(reloadPageOnShallowFalseUpdates: boolean) {
+function generateUpdateUrlFn(fullPageNavigationOnShallowFalseUpdates: boolean) {
   return function updateUrl(search: URLSearchParams, options: AdapterOptions) {
     const url = new URL(location.href)
     url.search = renderQueryString(search)
-    if (reloadPageOnShallowFalseUpdates && options.shallow === false) {
+    if (fullPageNavigationOnShallowFalseUpdates && options.shallow === false) {
       const method =
         options.history === 'push' ? location.assign : location.replace
       method.call(location, url)
@@ -36,11 +36,11 @@ function generateUpdateUrlFn(reloadPageOnShallowFalseUpdates: boolean) {
 }
 
 const NuqsReactAdapterContext = createContext({
-  reloadPageOnShallowFalseUpdates: false
+  fullPageNavigationOnShallowFalseUpdates: false
 })
 
 function useNuqsReactAdapter() {
-  const { reloadPageOnShallowFalseUpdates } = useContext(
+  const { fullPageNavigationOnShallowFalseUpdates } = useContext(
     NuqsReactAdapterContext
   )
   const [searchParams, setSearchParams] = useState(() => {
@@ -63,8 +63,8 @@ function useNuqsReactAdapter() {
     }
   }, [])
   const updateUrl = useMemo(
-    () => generateUpdateUrlFn(reloadPageOnShallowFalseUpdates),
-    [reloadPageOnShallowFalseUpdates]
+    () => generateUpdateUrlFn(fullPageNavigationOnShallowFalseUpdates),
+    [fullPageNavigationOnShallowFalseUpdates]
   )
   return {
     searchParams,
@@ -76,14 +76,14 @@ const NuqsReactAdapter = createAdapterProvider(useNuqsReactAdapter)
 
 export function NuqsAdapter({
   children,
-  reloadPageOnShallowFalseUpdates = false
+  fullPageNavigationOnShallowFalseUpdates = false
 }: {
   children: ReactNode
-  reloadPageOnShallowFalseUpdates?: boolean
+  fullPageNavigationOnShallowFalseUpdates?: boolean
 }) {
   return createElement(
     NuqsReactAdapterContext.Provider,
-    { value: { reloadPageOnShallowFalseUpdates } },
+    { value: { fullPageNavigationOnShallowFalseUpdates } },
     createElement(NuqsReactAdapter, null, children)
   )
 }

turbo.json

@@ -35,7 +35,7 @@
       "outputs": ["dist/**", "cypress/**"],
       "dependsOn": ["^build"],
       "env": [
-        "RELOAD_ON_SHALLOW_FALSE",
+        "FULL_PAGE_NAV_ON_SHALLOW_FALSE",
         "REACT_COMPILER",
         "E2E_NO_CACHE_ON_RERUN"
       ]