useQueryState for Next.js


useQueryState hook for Next.js - Like React.useState, but stored in the URL query string

Features

- 🔀 Supports both the app and pages routers
- 🧘‍♀️ Simple: the URL is the source of truth
- 🕰 Replace history or append to use the Back button to navigate state updates
- ⚡️ Built-in parsers for common state types (integer, float, boolean, Date, and more)
- ♊️ Related querystrings with useQueryStates
- 📡 Shallow mode by default for URL query updates, opt-in to notify server components
- 🗃 _new:_ Server cache for type-safe searchParams access in nested server components
- ⌛️ _new:_ Support for useTransition to get loading states on server updates

Installation

``shell
pnpm add nuqs
`

`shell
yarn add nuqs
`

`shell
npm install nuqs
`

> Note: the package is moving to a new name: nuqs :tada:
>
> The 1.x versions will also be available under next-usequerystate,
> but 2.x onwards will only be published under nuqs.

$3

| Next.js version range | Supported nuqs / next-usequerystate version |
| --------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------- |
| >=14.0.4 | nuqs@latest |
| 14.0.3 | nuqs@latest, with the windowHistorySupport experimental flag, see #417 |
| 14.0.2 | Not compatible, see issue #388 and Next.js PR #58297 |
| >= 13.1 && <= 14.0.1 | nuqs@latest |
| < 13.1 | next-usequerystate@1.7.3 |

Usage

`tsx
'use client' // app router: only works in client components

import { useQueryState } from 'nuqs'

export default () => {
const [name, setName] = useQueryState('name')
return (
<>


Hello, {name || 'anonymous visitor'}!


setName(e.target.value)} />
setName(null)}>Clear

)
}
`


Documentation

useQueryState takes one required argument: the key to use in the query string.

Like React.useState, it returns an array with the value present in the query
string as a string (or null if none was found), and a state updater function.

Example outputs for our hello world example:

| URL | name value | Notes |
| ------------ | ---------- | ----------------------------------------------------------------- |
| / | null | No name key in URL |
| /?name= | '' | Empty string |
| /?name=foo | 'foo' |
| /?name=2 | '2' | Always returns a string by default, see Parsing below |

Parsing

If your state type is not a string, you must pass a parsing function in the
second argument object.

We provide parsers for common and more advanced object types:

`ts
import {
parseAsString,
parseAsInteger,
parseAsFloat,
parseAsBoolean,
parseAsTimestamp,
parseAsIsoDateTime,
parseAsArrayOf,
parseAsJson,
parseAsStringEnum,
parseAsStringLiteral,
parseAsNumberLiteral
} from 'nuqs'

useQueryState('tag') // defaults to string
useQueryState('count', parseAsInteger)
useQueryState('brightness', parseAsFloat)
useQueryState('darkMode', parseAsBoolean)
useQueryState('after', parseAsTimestamp) // state is a Date
useQueryState('date', parseAsIsoDateTime) // state is a Date
useQueryState('array', parseAsArrayOf(parseAsInteger)) // state is number[]
useQueryState('json', parseAsJson()) // state is a Point

// Enums (string-based only)
enum Direction {
up = 'UP',
down = 'DOWN',
left = 'LEFT',
right = 'RIGHT'
}

const [direction, setDirection] = useQueryState(
'direction',
parseAsStringEnum(Object.values(Direction)) // pass a list of allowed values
.withDefault(Direction.up)
)

// Literals (string-based only)
const colors = ['red', 'green', 'blue'] as const

const [color, setColor] = useQueryState(
'color',
parseAsStringLiteral(colors) // pass a readonly list of allowed values
.withDefault('red')
)

// Literals (number-based only)
const diceSides = [1, 2, 3, 4, 5, 6] as const

const [side, setSide] = useQueryState(
'side',
parseAsNumberLiteral(diceSides) // pass a readonly list of allowed values
.withDefault(4)
)
`

You may pass a custom set of parse and serialize functions:

`tsx
import { useQueryState } from 'nuqs'

export default () => {
const [hex, setHex] = useQueryState('hex', {
// TypeScript will automatically infer it's a number
// based on what parse returns.
parse: (query: string) => parseInt(query, 16),
serialize: value => value.toString(16)
})
}
`

$3

> Note: see the Accessing searchParams in server components
> section for a more user-friendly way to achieve type-safety.

If you wish to parse the searchParams in server components, you'll need to
import the parsers from nuqs/server, which doesn't include
the "use client" directive.

You can then use the parseServerSide method:

`tsx
import { parseAsInteger } from 'nuqs/server'

type PageProps = {
searchParams: {
counter?: string | string[]
}
}

const counterParser = parseAsInteger.withDefault(1)

export default function ServerPage({ searchParams }: PageProps) {
const counter = counterParser.parseServerSide(searchParams.counter)
console.log('Server side counter: %d', counter)
return (
...
)
}
`

See the server-side parsing demo/pagination>)
for a live example showing how to reuse parser configurations between
client and server code.

> Note: parsers don't validate your data. If you expect positive integers
> or JSON-encoded objects of a particular shape, you'll need to feed the result
> of the parser to a schema validation library, like Zod.

Default value

When the query string is not present in the URL, the default behaviour is to
return null as state.

It can make state updating and UI rendering tedious. Take this example of a simple counter stored in the URL:

`tsx
import { useQueryState, parseAsInteger } from 'nuqs'

export default () => {
const [count, setCount] = useQueryState('count', parseAsInteger)
return (
<>


count: {count}


setCount(0)}>Reset
{/ handling null values in setCount is annoying: /}
setCount(c => c ?? 0 + 1)}>+
setCount(c => c ?? 0 - 1)}>-
setCount(null)}>Clear

)
}
`

You can specify a default value to be returned in this case:

`ts
const [count, setCount] = useQueryState('count', parseAsInteger.withDefault(0))

const increment = () => setCount(c => c + 1) // c will never be null
const decrement = () => setCount(c => c - 1) // c will never be null
const clearCount = () => setCount(null) // Remove query from the URL
`

Note: the default value is internal to React, it will not be written to the
URL.

Setting the state to null will remove the key in the query string and set the
state to the default value.

Options

$3

By default, state updates are done by replacing the current history entry with
the updated query when state changes.

You can see this as a sort of git squash, where all state-changing
operations are merged into a single history value.

You can also opt-in to push a new history item for each state change,
per key, which will let you use the Back button to navigate state
updates:

`ts
// Default: replace current history with new state
useQueryState('foo', { history: 'replace' })

// Append state changes to history:
useQueryState('foo', { history: 'push' })
`

Any other value for the history option will fallback to the default.

You can also override the history mode when calling the state updater function:

`ts
const [query, setQuery] = useQueryState('q', { history: 'push' })

// This overrides the hook declaration setting:
setQuery(null, { history: 'replace' })
`

$3

By default, query state updates are done in a _client-first_ manner: there are
no network calls to the server.

This is equivalent to the shallow option of the Next.js pages router set to true,
or going through the experimental windowHistorySupport
flag in the app router.

To opt-in to query updates notifying the server (to re-run getServerSideProps
in the pages router and re-render Server Components on the app router),
you can set shallow to false:

`ts
const [state, setState] = useQueryState('foo', { shallow: false })

// You can also pass the option on calls to setState:
setState('bar', { shallow: false })
`

$3

The Next.js router scrolls to the top of the page on navigation updates,
which may not be desirable when updating the query string with local state.

Query state updates won't scroll to the top of the page by default, but you
can opt-in to this behaviour (which was the default up to 1.8.0):

`ts
const [state, setState] = useQueryState('foo', { scroll: true })

// You can also pass the option on calls to setState:
setState('bar', { scroll: true })
`

$3

Because of browsers rate-limiting the History API, internal updates to the
URL are queued and throttled to a default of 50ms, which seems to satisfy
most browsers even when sending high-frequency query updates, like binding
to a text input or a slider.

Safari's rate limits are much higher and would require a throttle of around 340ms.
If you end up needing a longer time between updates, you can specify it in the
options:

`ts
useQueryState('foo', {
// Send updates to the server maximum once every second
shallow: false,
throttleMs: 1000
})

// You can also pass the option on calls to setState:
setState('bar', { throttleMs: 1000 })
`

> Note: the state returned by the hook is always updated instantly, to keep UI responsive.
> Only changes to the URL, and server requests when using shallow: false, are throttled.

If multiple hooks set different throttle values on the same event loop tick,
the highest value will be used. Also, values lower than 50ms will be ignored,
to avoid rate-limiting issues. Read more.

$3

When combined with shallow: false, you can use the useTransition hook to get
loading states while the server is re-rendering server components with the
updated URL.

Pass in the startTransition function from useTransition to the options
to enable this behaviour _(this will set shallow: false automatically for you)_:

`tsx
'use client'

import React from 'react'
import { useQueryState, parseAsString } from 'nuqs'

function ClientComponent({ data }) {
// 1. Provide your own useTransition hook:
const [isLoading, startTransition] = React.useTransition()
const [query, setQuery] = useQueryState(
'query',
// 2. Pass the startTransition as an option:
parseAsString().withOptions({ startTransition })
)
// 3. isLoading will be true while the server is re-rendering
// and streaming RSC payloads, when the query is updated via setQuery.

// Indicate loading state
if (isLoading) return

// Normal rendering with data
return


}
`

Configuring parsers, default value & options

You can use a builder pattern to facilitate specifying all of those things:

`ts
useQueryState(
'counter',
parseAsInteger.withDefault(0).withOptions({
history: 'push',
shallow: false
})
)
`

You can get this pattern for your custom parsers too, and compose them
with others:

`ts
import { createParser, parseAsHex } from 'nuqs'

// Wrapping your parser/serializer in createParser
// gives it access to the builder pattern & server-side
// parsing capabilities:
const hexColorSchema = createParser({
parse(query) {
if (query.length !== 6) {
return null // always return null for invalid inputs
}
return {
// When composing other parsers, they may return null too.
r: parseAsHex.parse(query.slice(0, 2)) ?? 0x00,
g: parseAsHex.parse(query.slice(2, 4)) ?? 0x00,
b: parseAsHex.parse(query.slice(4)) ?? 0x00
}
},
serialize({ r, g, b }) {
return (
parseAsHex.serialize(r) +
parseAsHex.serialize(g) +
parseAsHex.serialize(b)
)
}
})
// Eg: set common options directly
.withOptions({ history: 'push' })

// Or on usage:
useQueryState(
'tribute',
hexColorSchema.withDefault({
r: 0x66,
g: 0x33,
b: 0x99
})
)
`

Note: see this example running in the hex-colors demo/hex-colors/page.tsx>).

Multiple Queries (batching)

You can call as many state update function as needed in a single event loop
tick, and they will be applied to the URL asynchronously:

`ts
const MultipleQueriesDemo = () => {
const [lat, setLat] = useQueryState('lat', parseAsFloat)
const [lng, setLng] = useQueryState('lng', parseAsFloat)
const randomCoordinates = React.useCallback(() => {
setLat(Math.random() * 180 - 90)
setLng(Math.random() * 360 - 180)
}, [])
}
`

If you wish to know when the URL has been updated, and what it contains, you can
await the Promise returned by the state updater function, which gives you the
updated URLSearchParameters object:

`ts
const randomCoordinates = React.useCallback(() => {
setLat(42)
return setLng(12)
}, [])

randomCoordinates().then((search: URLSearchParams) => {
search.get('lat') // 42
search.get('lng') // 12, has been queued and batch-updated
})
`

Implementation details (Promise caching)

The returned Promise is cached until the next flush to the URL occurs,
so all calls to a setState (of any hook) in the same event loop tick will
return the same Promise reference.

Due to throttling of calls to the Web History API, the Promise may be cached
for several ticks. Batched updates will be merged and flushed once to the URL.
This means not every setState will reflect to the URL, if another one comes
overriding it before flush occurs.

The returned React state will reflect all set values instantly,
to keep UI responsive.

---

useQueryStates

For query keys that should always move together, you can use useQueryStates
with an object containing each key's type:

`ts
import { useQueryStates, parseAsFloat } from 'nuqs'

const [coordinates, setCoordinates] = useQueryStates(
{
lat: parseAsFloat.withDefault(45.18),
lng: parseAsFloat.withDefault(5.72)
},
{
history: 'push'
}
)

const { lat, lng } = coordinates

// Set all (or a subset of) the keys in one go:
const search = await setCoordinates({
lat: Math.random() * 180 - 90,
lng: Math.random() * 360 - 180
})
`

Accessing searchParams in Server Components

If you wish to access the searchParams in a deeply nested Server Component
(ie: not in the Page component), you can use createSearchParamsCache
to do so in a type-safe manner.

> Note: parsers don't validate your data. If you expect positive integers
> or JSON-encoded objects of a particular shape, you'll need to feed the result
> of the parser to a schema validation library, like Zod.

`tsx
// searchParams.ts
import {
createSearchParamsCache,
parseAsInteger,
parseAsString
} from 'nuqs/server'
// Note: import from 'nuqs/server' to avoid the "use client" directive

export const searchParamsCache = createSearchParamsCache({
// List your search param keys and associated parsers here:
q: parseAsString.withDefault(''),
maxResults: parseAsInteger.withDefault(10)
})

// page.tsx
import { searchParamsCache } from './searchParams'

export default function Page({
searchParams
}: {
searchParams: Record
}) {
// ⚠️ Don't forget to call parse here.
// You can access type-safe values from the returned object:
const { q: query } = searchParamsCache.parse(searchParams)
return (


)
}

function Results() {
// Access type-safe search params in children server components:
const maxResults = searchParamsCache.get('maxResults')
return Showing up to {maxResults} results
}
`

The cache will only be valid for the current page render
(see React's cache function).

Note: the cache only works for server components, but you may share your
parser declaration with useQueryStates for type-safety in client components:

`tsx
// searchParams.ts
import { parseAsFloat, createSearchParamsCache } from 'nuqs/server'

export const coordinatesParsers = {
lat: parseAsFloat.withDefault(45.18),
lng: parseAsFloat.withDefault(5.72)
}
export const coordinatesCache = createSearchParamsCache(coordinatesParsers)

// page.tsx
import { coordinatesCache } from './searchParams'
import { Server } from './server'
import { Client } from './client'

export default function Page({ searchParams }) {
coordinatesCache.parse(searchParams)
return (
<>





)
}

// server.tsx
import { coordinatesCache } from './searchParams'

export function Server() {
const { lat, lng } = coordinatesCache.all()
// or access keys individually:
const lat = coordinatesCache.get('lat')
const lng = coordinatesCache.get('lng')
return (

Latitude: {lat} - Longitude: {lng}

)
}

// client.tsx
// prettier-ignore
;'use client'

import { useQueryStates } from 'nuqs'
import { coordinatesParsers } from './searchParams'

export function Client() {
const [{ lat, lng }, setCoordinates] = useQueryStates(coordinatesParsers)
// ...
}
`

Serializer helper

To populate components with state values, you can use the createSerializer
helper.

Pass it an object describing your search params, and it will give you a function
to call with values, that generates a query string serialized as the hooks would do.

Example:

`ts
import {
createSerializer,
parseAsInteger,
parseAsIsoDateTime,
parseAsString,
parseAsStringLiteral
} from 'nuqs/server'

const searchParams = {
search: parseAsString,
limit: parseAsInteger,
from: parseAsIsoDateTime,
to: parseAsIsoDateTime,
sortBy: parseAsStringLiteral(['asc', 'desc'] as const)
}

// Create a serializer function by passing the description of the search params to accept
const serialize = createSerializer(searchParams)

// Then later, pass it some values (a subset) and render them to a query string
serialize({
search: 'foo bar',
limit: 10,
from: new Date('2024-01-01'),
// here, we omit to, which won't be added
sortBy: null // null values are also not rendered
})
// ?search=foo+bar&limit=10&from=2024-01-01T00:00:00.000Z
`

$3

The returned serialize function can take a base parameter over which to
append/amend the search params:

`ts
serialize('/path?baz=qux', { foo: 'bar' }) // /path?baz=qux&foo=bar

const search = new URLSearchParams('?baz=qux')
serialize(search, { foo: 'bar' }) // ?baz=qux&foo=bar

const url = new URL('https://example.com/path?baz=qux')
serialize(url, { foo: 'bar' }) // https://example.com/path?baz=qux&foo=bar

// Passing null removes existing values
serialize('?remove=me', { foo: 'bar', remove: null }) // ?foo=bar
`

Testing

Currently, the best way to test the behaviour of your components using
useQueryState(s) is end-to-end testing, with tools like Playwright or Cypress.

Running components that use the Next.js router in isolation requires mocking it,
which is being worked on
for the app router.

See issue #259 for more testing-related discussions.

Debugging

You can enable debug logs in the browser by setting the debug item in localStorage
to nuqs, and reload the page.

`js
// In your devtools:
localStorage.setItem('debug', 'nuqs')
`

> Note: unlike the debug package, this will not work with wildcards, but
> you can combine it: localStorage.setItem('debug', '*,nuqs')

Log lines will be prefixed with [nuqs] for useQueryState and [nuq+] for
useQueryStates, along with other internal debug logs.

User timings markers are also recorded, for advanced performance analysis using
your browser's devtools.

Providing debug logs when opening an issue
is always appreciated. 🙏

Caveats

Because the Next.js pages router is not available in an SSR context, this
hook will always return null (or the default value if supplied) on SSR/SSG.

This limitation doesn't apply to the app router.

$3

If your page uses query strings for local-only state, you should add a
canonical URL to your page, to tell SEO crawlers to ignore the query string
and index the page without it.

In the app router, this is done via the metadata object:

`ts
import type { Metadata } from 'next'

export const metadata: Metadata = {
alternates: {
canonical: '/url/path/without/querystring'
}
}
`

If however the query string is defining what content the page is displaying
(eg: YouTube's watch URLs, like https://www.youtube.com/watch?v=dQw4w9WgXcQ),
your canonical URL should contain relevant query strings, and you can still
use useQueryState to read it:

`ts
// page.tsx
import type { Metadata, ResolvingMetadata } from 'next'
import { useQueryState } from 'nuqs'
import { parseAsString } from 'nuqs/server'

type Props = {
searchParams: { [key: string]: string | string[] | undefined }
}

export async function generateMetadata({
searchParams
}: Props): Promise {
const videoId = parseAsString.parseServerSide(searchParams.v)
return {
alternates: {
canonical: /watch?v=${videoId}
}
}
}
`

$3

If your serializer loses precision or doesn't accurately represent
the underlying state value, you will lose this precision when
reloading the page or restoring state from the URL (eg: on navigation).

Example:

`ts
const geoCoordParser = {
parse: parseFloat,
serialize: v => v.toFixed(4) // Loses precision
}

const [lat, setLat] = useQueryState('lat', geoCoordParser)
`

Here, setting a latitude of 1.23456789 will render a URL query string
of lat=1.2345, while the internal lat` state will be correctly
set to 1.23456789.

Upon reloading the page, the state will be incorrectly set to 1.2345.

License

MIT

Made with ❤️ by François Best

Using this package at work ? Sponsor me
to help with support and maintenance.

!Project analytics and stats