Allow adapter specific defaults

[gijsroge]

If you are using Remix or React Router 7, there is a good chance you want to set shallow to false by default.

But currently I don't think its possible to change the global defaults. So it becomes very tedious to add it to all your useQueryState(s) hooks.

It would make sense to be able to set the defaults yourself by maybe providing them to the <NuqsAdapter> component.

[mwskwong]

+1 to this idea (same as all adapters in general, e.g. Next.js adapter). I would propose something like:

<NuqsAdapter defaultOptions={{ shallow: false }}> // new prop
  {children}
</NuqsAdapter>

And then:

export function useNuqsWhateverAdapter(defaultConfig): AdapterInterface { // new func arg
  // ...
}

[knownasilya]

Sounds good to me

[TkDodo]

Not sure I like the setGlobalConfig approach. For one, it will make modules side-effect full. Also, it won’t allow to have different configs for different parts of an application, and might even be bad for mono-repos where packages use the same version of nuqs but with different default configs.

I think not affecting things outside of React is an okay tradeoff. If I call createSerializer on the top of my module, I wouldn’t expect it to be affected by a default value set on an <Adapter> somewhere in the component tree.

If we wanted that, we could expose a hook version of createSerializer:

const useCreateSerializer = () => {
  const defaultOptions = useDefaultOptions() // reads from nuqs adapter context
  
  return createSerializer(defaultOptions)
}

[franky47]

Also, not all options are relevant outside of a React context: shallow (which is likely the most useful one to override globally) isn't used anywhere but the hooks (for now at least). Same would be for the throttle and debounce options (limitUrlUpdates which is currently in beta).

So using Context for those would be relevant, and we could also piggyback other requested features based on global options (like sorting search params alphabetically) into that context.

[TkDodo]

made a PR here to add shallow as a potential defaultOption:

• feat: defaultOptions for NuqsAdapter #1066

[franky47]

Shipped in [email protected], thanks @TkDodo! 🙌