franky47 commented 1 year ago

🗺️ Roadmap

Coming up

Library

Showcasing the use of Zod in parsers for validation - #446
Refactor the queue system to handle both throttle and debounce behaviours, see Discusson #291.
Provide ways to read current search params and set them to the URL in a one-off way (outside of a React hook context), using the same parsers and options.
~Add a global default options context provider~ → probably not needed
Investigate support for shallow: false in Remix (Tweet, Skeet)
Refactor the cache system to allow parsing from an object of parsers without caching, for other frameworks (eg: Remix loaders).

Research phase:

Linking & search params interception à la TS Router middleware
Middleware migrations to rename/edit search params keys & values, keeping support for old URLs while allowing app code to evolve. (Tweet)
Showcase integration with other "external" state managers (Zustand, Jotai, Valtio, Redux, etc)
Merging useQueryState and useQueryStates to a single API that accepts both types of params (typing this is going to be a wild ride).
State init function as a default value? See Discussion #606
Provide support for arrays of values with repeating keys (eg: ?q=foo&q=bar), see Discussion #484.
Add caveat about using router.refresh on shallow updates (resets the query string). Solutions are to use non-shallow updates, or to enable WHS. See https://github.com/47ng/next-usequerystate/issues/392#issuecomment-1816590258 → This needs a test to ensure whether this behaviour is still present or not.

Docs

Rename the "playground" into a "recipes" section
Showcase a complete pagination + filtering + ordering/sorting example with data fetching (no artificial delay). Maybe using shadcn table.
Figure out how to add interactive (editable + runnable) demos of the hooks, client-side only. HMR in prod?

🚀 Changelog

2.2.3

781
783

2.2.2

776

2.2.1

769

2.2.0

765
756
762
764

2.1.2

759
747

2.1.1

729

2.1.0

707
710
712
720
725
718

2.0.4

703

2.0.3

701

2.0.2

700

2.0.1

694
697

2.0.0

459
644

1.20.0

671
657

1.19.3

647
652

1.19.2

642

1.19.1

631

1.19.0

622
621
617

1.18.0

578

1.17.8

600

1.17.7

592

1.17.6

588

1.17.5

580

1.17.4

560

1.17.3

557

1.17.2

fix: Don't rely on URL for initial state (9912eef)

1.17.1

504

1.17.0

493

1.16.1

482

1.16.0

473
475

1.15.4

465

1.15.3

461

1.15.2

456

1.15.1

Fixes a bug where debugging information would only show when using next-usequerystate (not nuqs) in localStorage.debug.

1.15.0

453

1.14.1

451

1.14.0

Project rebranding to nuqs - https://github.com/47ng/nuqs/discussions/438

1.13.2

419 (history: "push" was broken for pages router)

1.13.1

Released when Next.js 14.0.4 landed with the shallow routing fix in https://github.com/vercel/next.js/pull/58861

425

1.13.0

397
406
413

1.12.2

Released when Next.js 14.0.3 landed with the prefetch fix in https://github.com/vercel/next.js/pull/58297.

395
Update CI to replace 14.0.1 with latest (and update branch protection to match)
Get https://github.com/vercel/next.js/pull/58297 reviewed and merged to re-enable compatibility with next@latest. See #388.

1.12.1

398
401

1.12.0

394

1.11.0

Handle higher rate limits on Safari (~100ms for 17+, ~300ms for older versions)
Allow catching unapplied search params when rate-limited
URLs to docs in errors

1.10.0

387
374

Talent30 commented 1 year ago

I'd like to try creating a new documentation site. But I'm not very artistic and in the end you might get a copy of the T3-env site if you don't mind....