Installation

Getting started

Install the nuqs package with your favourite package manager:

pnpm add nuqs
npm install nuqs
yarn add nuqs
bun add nuqs

Which version should I use?

Next.js version rangeSupported nuqs / next-usequerystate version
>=14.0.4nuqs@latest
14.0.3nuqs@latest, with the windowHistorySupport experimental flag, see #417
14.0.2Not compatible, see issue #388 and Next.js PR #58297
>= 13.1 && <= 14.0.1nuqs@latest
< 13.1next-usequerystate@1.7.3
What happened to `next-usequerystate`?

It was a mouthful to type, so I decided to abbreviate it to nuqs.

The nuqs name was introduced in 1.14.0, and next-usequerystate will mirror its versions for the rest of the 1.x.x range. The next major version update (2.0.0) and subsequent versions will only be published under the nuqs name.