🔡 React hook for easily getting and setting query param strings.
MIT License
Read the official documentation.
This hook allows you to use a query param string the same way you'd use regular React state (i.e. via React.useState).
You can also use the getQueryParams() and setQueryParams() functions to get/set query params yourself.
window
functions that don't interfere with router frameworks.getQueryParams()
or setQueryParams()
to get/set query params yourself.If this project helped you, please consider buying me a coffee or sponsoring me. Your support is much appreciated!
npm i react-use-query-param-string
import { useQueryParamString } from 'react-use-query-param-string';
// Will use query param `q` and have a default value of empty string.
// `initialized` will be true after the value has been read from the query params.
const [searchText, setSearchText, initialized] = useQueryParamString('q', '');
See the useQueryParamString docs for more usage details, including static functions.
Type definitions have been included for TypeScript support.
Favicon by Twemoji.
Open source software is awesome and so are you. 😎
Feel free to submit a pull request for bugs or additions, and make sure to update tests as appropriate. If you find a mistake in the docs, send a PR! Even the smallest changes help.
For major changes, open an issue first to discuss what you'd like to change.
If you found this project helpful, let the community know by giving it a star: 👉⭐
See LICENSE.md.