Security News
NIST Misses 2024 Deadline to Clear NVD Backlog
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
use-location-state
Advanced tools
store and retrieve state into/from the browsers location state using modern hooks
string | number | boolean | string[] | Date
yarn add use-location-state
Or install one of the optional router integrations
The useQueryState() works similar to the useState()
hook and returns the current value and a set function in a pair.
The important difference is that you need to pass a name before your default value for your state.
const [value, setValue] = useQueryState('itemName', 'default value')
The name you pass will be used in the query string store the state (after the state was changed).
setValue('different value')
After calling the set function with a new value, the state will be saved withing the query string of the browser, so that the new state is reproducable after reloads or history navigation (using forward / back button).
http://localhost:3000/#itemName=different+value
useQueryState() uses the browsers location.hash
property by default.
Check out the router integrations to use location.search
instead.
In cases where you want the updated state to be represented as a new entry in the history, you can pass a options argument to the set function, with the method property set to 'push'
.
setValue('a pushed value', { method: 'push' })
This changes the way this state change is handled when the user navigates. When the user now clicks the Back-Button, this state gets popped and the previous state is restored (instead of eg. navigating away).
import { useQueryState } from 'use-location-state'
function MyComponent() {
const [active, setActive] = useQueryState('active', true)
return (
<div>
<button type="button" onClick={() => setActive(!active)}>Toggle</button>
{active && <p>Some active content</p>}
</div>
)
}
import { useQueryState } from 'use-location-state'
function MyComponent() {
const [name, setName] = useQueryState('name', 'Sarah')
const [age, setAge] = useQueryState('age', 25)
const [active, setActive] = useQueryState('active', false)
// ...
}
In case you want use location.search
(after the question mark in the url) you need to use one of these extended versions of the package.
We plan to provide clean and easy-to-use integrations for all popular routers. At the moment we provide integrations for:
yarn add react-router-use-location-state
import { useQueryState } from 'react-router-use-location-state'
Usage works the same as described above, except that the URL will look like this now:
http://localhost:3000/?itemName=different+value
Your favorite router is missing? Feel free to suggest a router.
FAQs
react hook to the browsers location query state
The npm package use-location-state receives a total of 2,903 weekly downloads. As such, use-location-state popularity was classified as popular.
We found that use-location-state demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
Security News
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.