npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

use-store-state

v3.0.0

Published

A usestate-like react hook for interacting with the browser Local Storage API

Downloads

9

Readme

use-store-state

npm package Build Status Downloads Issues Commitizen Friendly Semantic Release Package Size

A usestate-like react hook for interacting with the browser Local Storage API

Install

npm install use-store-state

Usage

import { useStoreState } from 'use-store-state';

const [name, setName] = useStoreState('name', 'Bob');

console.log(name);
// 'Bob'

OR with typescript

import { useStoreState } from 'use-store-state';

const [isDarkMode, setIsDarkMode] = useStoreState<boolean>('darkMode', true);

// ERROR:
// Typescript should throw an error at this
setIsDarkMode('rink and rive');

// SUCCESS:
// This should pass
setIsDarkMode(false);

If no generic is passed, the type is inferred from the initial value, just the same way react useState works

import { useStoreState } from 'use-store-state';

const [isDarkMode, setIsDarkMode] = useStoreState('darkMode', true);

// ERROR:
// Typescript should also throw an error
setIsDarkMode('rink and rive');

// SUCCESS:
// This should pass
setIsDarkMode(false);

Also allows a callback to be passed as the parameter of setState.

import { useStoreState } from 'use-store-state';

const [isDarkMode, setIsDarkMode] = useStoreState('darkMode', true);

// Toggle dark mode on/off
setIsDarkMode(prev => !prev);

API

const [state, setState] = useStoreState(key, value?)

state

Type: Infered from the value passed in. If no value is passed, it defaults to undefined. Also defined by passing in a generic e.g <boolean> like in the typescript example above.

setState

Type:

React.Dispatch<React.SetStateAction<InferredType>>;
// Where `InferredType` is the type of the passed value or undefined

// OR

React.Dispatch<React.SetStateAction<DefinedType>>;
// Where `DefinedType` is the generic passed to `useStoreState` i.e boolean, string.

value

Type: any

PERKS

Added support for SSR. i.e Even though the local storage API is a browser API (window.localStorage), this should not break when using frameworks like NEXTJS or Vite-SSR which renders the component first on the server before hydrating on the client.