use-search-param

A React hook to safely and easily read from URL search params.

Docs for version 1.4.4 (the last version before version 2.0.0) can be viewed here

---

⚠️ Warning: this package is deprecated! ⚠️

Docs for version 2.3.0 (the last version before being deprecated) can be viewed here

As an alternative, use use-search-param-state:

1import { useSearchParamState } from "use-search-param-state";
2
3function Demo() {
4  const [counter] = useSearchParamState("c", 0);
5}

All of the options from use-search-param:

1interface Options<TVal> {
2  sanitize?: (unsanitized: string) => string;
3  parse?: (unparsed: string) => TVal;
4  validate?: (unvalidated: unknown) => TVal | null;
5  onError?: (error: unknown) => void;
6  serverSideSearchParams?: string;
7}

are still supported, though note that serverSideSearchParams is updated to serverSideURLSearchParams: URLSearchParams in use-search-param-state

Why deprecate?

Prior to use-search-param-state v3.0.0, useSearchParamState required being wrapped in a context provider: SearchParamStateProvider. For cases where setting the state wasn't necessary, use-search-param provided a simpler alternative with the same API - but without a provider wrapping your app.

In v3.0.0, use-search-param-state was refactored to remove the need for a context provider. Without a provider, there's no longer a significant difference between use-search-param-state and use-search-param, and no reason to maintain both libraries.