@rdeak/use-search-state
v1.0.0
Published
Store the state in the URL, share it, and easily recreate it.
Downloads
1
Readme
use-search-state
Store the state in the URL, share it, and easily recreate it.
Installation
npm install react-router-dom @rdeak/use-search-state
or
npm install react-router-dom https://github.com/rdeak/use-search-state
Usage
import useSearchState from "@rdeak/use-search-state";
const [state, setState] = useSearchState();
// state = {}
// with initial values
const [withIntialState, setWithInitalState] = useSearchState({
name: "Jane Doe",
});
// withIntialState = {"name": "Jane Doe"}
// set value
setState({ name: "John Doe", classes: ["G-1", "R-2"] });
// state = {"name":"John Doe", "classes": ["G-1","R-2"]}
// add just portion of state
setState({ address: "Main Road 8" });
// state = {"name":"John Doe", "classes": ["G-1","R-2"], "address": "Main Road 8"}
// numeric values are converted to string
setState({ height: 180 });
// state = {"name":"John Doe", "classes": ["G-1","R-2"], "address": "Main Road 8", "height": "180"}
// remove value
setState({ classes: null });
// state = {"name":"John Doe", "address": "Main Road 8"}
// clear all
setState(null);
// state = {}
License
This project is licensed under the terms of the MIT license.