When creating apps with easily shareable URLs, you often want to encode state as query parameters, but all query parameters must be encoded as strings. useQueryParams allows you to easily encode and decode data of any type as query parameters with smart memoization to prevent creating unnecessary duplicate objects. It uses serialize-query-params.

Migrating from v1? See details in the changelog.

Installation

Using npm:

$ npm install --save use-query-params

Link your routing system via an adapter (e.g., React Router 6 example, React Router 5 example):

import React from 'react';
import ReactDOM from 'react-dom/client';
import { QueryParamProvider } from 'use-query-params';
import { ReactRouter6Adapter } from 'use-query-params/adapters/react-router-6';
import { BrowserRouter, Route, Routes } from 'react-router-dom';
import App from './App';

const root = ReactDOM.createRoot(
  document.getElementById('root') as HTMLElement
);
root.render(
  
    
      
        }>
      
    
  ,
  document.getElementById('root')
);

By default, use-query-params uses URLSearchParams to handle interpreting the location string, which means it does not decode null and has limited handling of other more advanced URL parameter configurations. If you want access to those features, add a third-party library like query-string and tell use-query-params to use it:

import React from 'react';
import ReactDOM from 'react-dom/client';
import { QueryParamProvider } from 'use-query-params';
import { ReactRouter6Adapter } from 'use-query-params/adapters/react-router-6';
import { BrowserRouter, Route, Routes } from 'react-router-dom';
// optionally use the query-string parse / stringify functions to
// handle more advanced cases than URLSearchParams supports.
import { parse, stringify } from 'query-string';
import App from './App';

const root = ReactDOM.createRoot(
  document.getElementById('root') as HTMLElement
);
root.render(
  
    
      
        }>
      
    
  ,
  document.getElementById('root')
);
      

Usage

Be sure to add QueryParamProvider as shown in Installation above.

Add the hook to your component. There are two options: useQueryParam:

import * as React from 'react';
import { useQueryParam, NumberParam, StringParam } from 'use-query-params';

const UseQueryParamExample = () => {
  // something like: ?x=123&foo=bar in the URL
  const [num, setNum] = useQueryParam('x', NumberParam);
  const [foo, setFoo] = useQueryParam('foo', StringParam);

  return (
    <div>
      <h1>num is {num}</h1>
      <button> setNum(Math.random())}&gt;Change</button>
      <h1>foo is {foo}</h1>
      <button> setFoo(`str${Math.random()}`)}&gt;Change</button>
    </div>
  );
};

export default UseQueryParamExample;

Or useQueryParams:

import * as React from 'react';
import {
  useQueryParams,
  StringParam,
  NumberParam,
  ArrayParam,
  withDefault,
} from 'use-query-params';

// create a custom parameter with a default value
const MyFiltersParam = withDefault(ArrayParam, [])

const UseQueryParamsExample = () => {
  // something like: ?x=123&q=foo&filters=a&filters=b&filters=c in the URL
  const [query, setQuery] = useQueryParams({
    x: NumberParam,
    q: StringParam,
    filters: MyFiltersParam,
  });
  const { x: num, q: searchQuery, filters } = query;

  return (
    <div>
      <h1>num is {num}</h1>
      <button> setQuery({ x: Math.random() })}&gt;Change</button>
      <h1>searchQuery is {searchQuery}</h1>
      <h1>There are {filters.length} filters active.</h1>
      <button>
          setQuery(
            { x: Math.random(), filters: [...filters, 'foo'], q: 'bar' },
            'push'
          )
        }
      &gt;
        Change All
      </button>
    </div>
  );
};

export default UseQueryParamsExample;

import * as React from 'react';
import {
  withQueryParams,
  StringParam,
  NumberParam,
  ArrayParam,
  withDefault,
} from 'use-query-params';

const WithQueryParamsExample = ({ query, setQuery }: any) => {
  const { x: num, q: searchQuery, filters } = query;

  return (
    <div>
      <h1>num is {num}</h1>
      <button> setQuery({ x: Math.random() })}&gt;Change</button>
      <h1>searchQuery is {searchQuery}</h1>
      <h1>There are {filters.length} filters active.</h1>
      <button>
          setQuery(
            { x: Math.random(), filters: [...filters, 'foo'], q: 'bar' },
            'push'
          )
        }
      &gt;
        Change All
      </button>
    </div>
  );
};

// create a custom parameter with a default value
const MyFiltersParam = withDefault(ArrayParam, [])

export default withQueryParams({
  x: NumberParam,
  q: StringParam,
  filters: MyFiltersParam,
}, WithQueryParamsExample);

import * as React from 'react';
import {
  QueryParams,
  StringParam,
  NumberParam,
  ArrayParam,
  withDefault,
} from 'use-query-params';

// create a custom parameter with a default value
const MyFiltersParam = withDefault(ArrayParam, [])

const RenderPropsExample = () => {
  const queryConfig = {
    x: NumberParam,
    q: StringParam,
    filters: MyFiltersParam,
  };
  return (
    <div>
      
        {({ query, setQuery }) =&gt; {
          const { x: num, q: searchQuery, filters } = query;
          return (
            &lt;&gt;
              <h1>num is {num}</h1>
              <button> setQuery({ x: Math.random() })}&gt;
                Change
              </button>
              <h1>searchQuery is {searchQuery}</h1>
              <h1>There are {filters.length} filters active.</h1>
              <button>
                  setQuery(
                    {
                      x: Math.random(),
                      filters: [...filters, 'foo'],
                      q: 'bar',
                    },
                    'push'
                  )
                }
              &gt;
                Change All
              </button>
            
          );
        }}
      
    </div>
  );
};

export default RenderPropsExample;

Examples

A few basic examples have been put together to demonstrate how useQueryParams works with different routing systems.

• React Router 6 Example
• React Router 5 Example

API

• UrlUpdateType
• Param Types
• useQueryParam
• useQueryParams
• withQueryParams
• QueryParams
• encodeQueryParams
• QueryParamProvider
• Type Definitions and from serialize-query-params.
• Serialization Utility Functions

For convenience, use-query-params exports all of the serialize-query-params library.

UrlUpdateType

The UrlUpdateType is a string type definings the different methods for updating the URL:

• 'pushIn': Push just a single parameter, leaving the rest as is (back button works) (the default)
• 'push': Push all parameters with just those specified (back button works)
• 'replaceIn': Replace just a single parameter, leaving the rest as is
• 'replace': Replace all parameters with just those specified

Param Types

See all param definitions from serialize-query-params here. You can define your own parameter types by creating an object with an encode and a decode function. See the existing definitions for examples.

Note that all null and empty values are typically treated as follows:

Note that with the default searchStringToObject implementation that uses URLSearchParams, null and empty values are treated as follows:

If you need a more discerning interpretation, you can use query-string's parse and stringify to get:

Examples in this table assume query parameter named qp.

Example

import { ArrayParam, useQueryParam, useQueryParams } from 'use-query-params';

// typically used with the hooks:
const [foo, setFoo] = useQueryParam('foo', ArrayParam);
// - OR -
const [query, setQuery] = useQueryParams({ foo: ArrayParam });

Example with Custom Param

You can define your own params if the ones shipped with this package don't work for you. There are included serialization utility functions to make this easier, but you can use whatever you like.

import {
  encodeDelimitedArray,
  decodeDelimitedArray
} from 'use-query-params';

/** Uses a comma to delimit entries. e.g. ['a', 'b'] => qp?=a,b */
const CommaArrayParam = {
  encode: (array: string[] | null | undefined) =>
    encodeDelimitedArray(array, ','),

  decode: (arrayStr: string | string[] | null | undefined) =>
    decodeDelimitedArray(arrayStr, ',')
};

useQueryParam

useQueryParam(
  name: string,
  paramConfig?: QueryParamConfig,
  options?: QueryParamOptions
): [
  TypeFromDecode, 
  (newValue: NewValueType, updateType?: UrlUpdateType) => void
]

Given a query param name and query parameter configuration { encode, decode } return the decoded value and a setter for updating it. If you do not provide a paramConfig, it inherits it from what was defined in the QueryParamProvider, falling back to StringParam if nothing is found.

The setter takes two arguments (newValue, updateType) where updateType is one of 'pushIn' | 'push' | 'replaceIn' | 'replace', defaulting to 'pushIn'.

You can override options from the QueryParamProvider with the third argument. See QueryParamOptions for details.

Example

import { useQueryParam, NumberParam } from 'use-query-params';

// reads query parameter `foo` from the URL and stores its decoded numeric value
const [foo, setFoo] = useQueryParam('foo', NumberParam);
setFoo(500);
setFoo(123, 'push');

// to unset or remove a parameter set it to undefined and use pushIn or replaceIn update types
setFoo(undefined) // ?foo=123&bar=zzz becomes ?bar=zzz

// functional updates are also supported:
setFoo((latestFoo) => latestFoo + 150)

useQueryParams

// option 1: pass only a config with possibly some options
useQueryParams(
  paramConfigMap: QPCMap,
  options?: QueryParamOptions
): [DecodedValueMap, SetQuery];

// option 2: pass an array of param names, relying on predefined params for types
useQueryParams(
  names: string[],
  options?: QueryParamOptions
): [DecodedValueMap, SetQuery];

// option 3: pass no args, get all params back that were predefined in a proivder
useQueryParams(
): [DecodedValueMap, SetQuery];

Given a query parameter configuration (mapping query param name to { encode, decode }), return an object with the decoded values and a setter for updating them.

The setter takes two arguments (newQuery, updateType) where updateType is one of 'pushIn' | 'push' | 'replaceIn' | 'replace', defaulting to 'pushIn'.

You can override options from the QueryParamProvider with the options argument. See QueryParamOptions for details.

Example

import { useQueryParams, StringParam, NumberParam } from 'use-query-params';

// reads query parameters `foo` and `bar` from the URL and stores their decoded values
const [query, setQuery] = useQueryParams({ foo: NumberParam, bar: StringParam });
setQuery({ foo: 500 })
setQuery({ foo: 123, bar: 'zzz' }, 'push');

// to unset or remove a parameter set it to undefined and use pushIn or replaceIn update types
setQuery({ foo: undefined }) // ?foo=123&bar=zzz becomes ?bar=zzz

// functional updates are also supported:
setQuery((latestQuery) => ({ foo: latestQuery.foo + 150 }))

Example with Custom Parameter Type Parameter types are just objects with { encode, decode } functions. You can provide your own if the provided ones don't work for your use case.

import { useQueryParams } from 'use-query-params';

const MyParam = {
  encode(value) {
    return `${value * 10000}`;
  },

  decode(strValue) {
    return parseFloat(strValue) / 10000;
  }
}

// ?foo=10000 -> query = { foo: 1 }
const [query, setQuery] = useQueryParams({ foo: MyParam });

// goes to ?foo=99000
setQuery({ foo: 99 })

withQueryParams

withQueryParams>
  (paramConfigMap: QPCMap, WrappedComponent: React.ComponentType<p>):
      React.FC&gt;&gt;

Given a query parameter configuration (mapping query param name to { encode, decode }) and a component, inject the props query and setQuery into the component based on the config.

The setter takes two arguments (newQuery, updateType) where updateType is one of 'pushIn' | 'push' | 'replaceIn' | 'replace', defaulting to 'pushIn'.

Example

import { withQueryParams, StringParam, NumberParam } from 'use-query-params';

const MyComponent = ({ query, setQuery, ...others }) => {
  const { foo, bar } = query;
  return </p><div>foo = {foo}, bar = {bar}</div>
}

// reads query parameters `foo` and `bar` from the URL and stores their decoded values
export default withQueryParams({ foo: NumberParam, bar: StringParam }, MyComponent);

Note there is also a variant called withQueryParamsMapped that allows you to do a react-redux style mapStateToProps equivalent. See the code or this example for details.

QueryParams

  {({ query, setQuery }) =&gt; <div>foo = {query.foo}</div>}

Given a query parameter configuration (mapping query param name to { encode, decode }) and a component, provide render props query and setQuery based on the config.

The setter takes two arguments (newQuery, updateType) where updateType is one of 'pushIn' | 'push' | 'replaceIn' | 'replace', defaulting to 'pushIn'.

encodeQueryParams

encodeQueryParams(
  paramConfigMap: QPCMap,
  query: Partial>
): Partial>

Convert the values in query to strings via the encode functions configured in paramConfigMap. This can be useful for constructing links using decoded query parameters.

Example

import { encodeQueryParams, NumberParam } from 'use-query-params';
// since v1.0 stringify is not exported from 'use-query-params',
// so you must install the 'query-string' package in case you need it
import { stringify } from 'query-string';

// encode each parameter according to the configuration
const encodedQuery = encodeQueryParams({ foo: NumberParam }, { foo });
const link = `/?${stringify(encodedQuery)}`;

QueryParamProvider

// choose an adapter, depending on your router
import { ReactRouter6Adapter } from 'use-query-params/adapters/react-router-6';
import { ReactRouter5Adapter } from 'use-query-params/adapters/react-router-5';


// optionally specify options
import { parse, stringify } from 'query-string';
const options = {
  searchStringToObject: parse,
  objectToSearchString: stringify,
}

  


// optionally nest parameters in options to get automatically on useQueryParams calls

   {/* useQueryParams calls have access to foo here */}
    ...
    
      
        ... {/* useQueryParams calls have access to foo and bar here */}
      
    
    ...
  

The QueryParamProvider component links your routing library's history to the useQueryParams hook. It is needed for the hook to be able to update the URL and have the rest of your app know about it.

You can specify global options at the provider level.

QueryParamOptions

Development

Run the typescript compiler in watch mode:

npm run dev

You can run an example app:

npm link
cd examples/react-router
npm install
npm link use-query-params
npm start