JIYIK CN >

Use useSearchParamshooks to programmatically update query parameters in React Router, for example setSearchParams({query: 'myValue'}). useSearchParamsHooks are used to read and modify the query string in the URL of the current location.

import React from 'react';
import {
  useSearchParams,
} from 'react-router-dom';

export default function App() {
  const [searchParams, setSearchParams] = useSearchParams();

  const handleClick = () => {
    setSearchParams({myParam: 'hello_world'});
  };

  const handleChange = event => {
    setSearchParams({query: event.target.value});
  };

  console.log(searchParams.get('myParam'));
  console.log(searchParams.get('query'));

  return (
    <div>
      <button onClick={handleClick}>Update Query params</button>

      <input id="search" onChange={handleChange} />
    </div>
  );
}

We have to make sure we wrap our App with the Router component in our index.js file in order to use any of the React router hooks.

import {createRoot} from 'react-dom/client';
import App from './App';
import {BrowserRouter as Router} from 'react-router-dom';

const rootElement = document.getElementById('root');
const root = createRoot(rootElement);

// 👇️ wrap App in Router

root.render(
  <Router>
    <App />
  </Router>
);

The code snippet shows how to update the query parameters of the route when a button is clicked and an input field is changed.

useSearchParamsHooks are used to read and modify the query string in the URL of the current location.

It returns an array with 2 elements - const [searchParams, setSearchParams] = useSearchParams().

The first element is an object that we can use to get the value of the query parameter, and the second element is a function that takes an object of key-value pairs and sets the query parameter to that object.

setSearchParamsThe navigate function works similarly to the navigate function in the useNavigate hook, but only applies to the search portion of the URL.

If we need to programmatically navigate to a different route using query parameters, use useNavigatethe hook instead.

// 👇️ import useNavigate
import {useNavigate} from 'react-router-dom';

export default function App() {
  const navigate = useNavigate();

  const handleClick = () => {
    // 👇️ navigate programmatically
    navigate({pathname: '/about', search: '?query=abc&page=25'});
  };

  return (
    <div>
      <button onClick={handleClick}>Navigate to About</button>
    </div>
  );
}

We pass an object to navigatethe function. Note that searchthe properties are a complete query string.

When the user clicks the button, they will be navigated to /about?query=abc&page=25.