Skip to content

Commit d6f2856

Browse files
franky47franky47
committed
doc: Update Next.js supported versions
1 parent 3cdfcdc commit d6f2856

File tree

4 files changed

+19
-28
lines changed

4 files changed

+19
-28
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ Are you using:
2929
- ✅/❌ The app router
3030
- ✅/❌ The pages router
3131
- ✅/❌ The `basePath` option in your Next.js config
32-
- ✅/❌ The experimental `windowHistorySupport` flag in your Next.js config _(only relevant for Next.js 14.0.3 or 14.0.4)_
3332

3433
## Description
3534

‎README.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,14 @@ npm install nuqs
4141
4242
### Which version should I use?
4343

44-
| Next.js version range | Supported `nuqs` / `next-usequerystate` version |
45-
| --------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------- |
46-
| >=14.0.4 | `nuqs@latest` |
47-
| 14.0.3 | `nuqs@latest`, with the `windowHistorySupport` experimental flag, see [#417](https://github.com/47ng/nuqs/issues/417) |
48-
| 14.0.2 | Not compatible, see issue [#388](https://github.com/47ng/nuqs/issues/388) and Next.js PR [#58297](https://github.com/vercel/next.js/pull/58297) |
49-
| >= 13.1 && <= 14.0.1 | `nuqs@latest` |
50-
| < 13.1 | `next-usequerystate@1.7.3` |
44+
| Next.js version range | Supported `nuqs` version |
45+
| ----------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------- |
46+
| >= 14.1.2 | `nuqs@latest` |
47+
| >=14.0.4 && \<\= 14.1.1 | `nuqs@^1` |
48+
| 14.0.3 | `nuqs@^1`, with the `windowHistorySupport` experimental flag, see [#417](https://github.com/47ng/nuqs/issues/417) |
49+
| 14.0.2 | Not compatible, see issue [#388](https://github.com/47ng/nuqs/issues/388) and Next.js PR [#58297](https://github.com/vercel/next.js/pull/58297) |
50+
| >= 13.1 && \<\= 14.0.1 | `nuqs@^1` |
51+
| < 13.1 | `next-usequerystate@1.7.3` |
5152

5253
## Usage
5354

‎packages/docs/content/docs/installation.mdx

+8-15
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,11 @@ bun add nuqs
2323

2424
## Which version should I use?
2525

26-
| Next.js version range | Supported `nuqs` / `next-usequerystate` version |
27-
| --------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------ |
28-
| >=14.0.4 | `nuqs@latest` |
29-
| 14.0.3 | `nuqs@latest`, with the `windowHistorySupport` experimental flag, see [#417](https://github.com/47ng/nuqs/issues/417) |
30-
| 14.0.2 | Not compatible, see issue [#388](https://github.com/47ng/nuqs/issues/388) and Next.js PR [#58297](https://github.com/vercel/next.js/pull/58297) |
31-
| >= 13.1 && \<\= 14.0.1 | `nuqs@latest` |
32-
| < 13.1 | `next-usequerystate@1.7.3` |
33-
34-
<Callout title={<>What happened to `next-usequerystate`?</>}>
35-
It was a mouthful to type, so I decided to abbreviate it to `nuqs`.
36-
37-
The `nuqs` name was introduced in 1.14.0, and `next-usequerystate` mirrored
38-
its versions for the rest of the 1.x.x range. The next major version update
39-
(2.0.0) and subsequent versions will only be published under the `nuqs` name.
40-
</Callout>
26+
| Next.js version range | Supported `nuqs` version |
27+
| ----------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------- |
28+
| >= 14.1.2 | `nuqs@latest` |
29+
| >=14.0.4 && \<\= 14.1.1 | `nuqs@^1` |
30+
| 14.0.3 | `nuqs@^1`, with the `windowHistorySupport` experimental flag, see [#417](https://github.com/47ng/nuqs/issues/417) |
31+
| 14.0.2 | Not compatible, see issue [#388](https://github.com/47ng/nuqs/issues/388) and Next.js PR [#58297](https://github.com/vercel/next.js/pull/58297) |
32+
| >= 13.1 && \<\= 14.0.1 | `nuqs@^1` |
33+
| < 13.1 | `next-usequerystate@1.7.3` |

‎packages/docs/content/docs/migrations/v2.mdx

+3-5
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,10 @@ title: Migration guide to v2
33
description: How to update your code to use nuqs@2.0.0
44
---
55

6-
## Dropped support for `next@14.0.3`
6+
## Support moved to `next@>=14.1.2`
77

8-
It may seem weird to drop support for a single patch version, and keep it for
9-
older versions, but this is due to a bug in shallow routing in Next.js 14.0.3
10-
that was fixed in 14.0.4, and that became hard to work around without ugly hacks
11-
as Next.js releases evolved.
8+
Early versions of Next.js 14 were in flux with regards to shallow routing,
9+
only from 14.1.2 is it stable enough to not require ugly hacks.
1210

1311
See #423 for context and a table of supported versions.
1412

0 commit comments

Comments
 (0)