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

react-use-storage-state

v1.0.6

Published

React use hook for shared and persisted state

Downloads

1,258

Readme

react-use-storage-state

React use hook for shared and persisted state

npm Package Version Minified Package Size Minified and Gzipped Package Size npm Package Downloads JavaScript Style Guide

Imagine like recoil or redux without reducer and actions combined with localStorage.

This package provider simpler development experiment (DX) for shared state than redux. You can update the shared state directly, without writing verbose code to ~~obtain dispatcher, create action, dispatch action, construct new state in reducer, and return sub-state in selector~~.

Features

  • Auto save and restore state across page refresh
  • Shared state across multiple components (realtime update)
  • Familiar usage as React.useState()
  • Auto reset state when initialState is changed
  • Support any JSON-compatible data type (not just string)
  • Error handling when storage permission is denied or passing non-serializable object (e.g. with cyclic reference)
  • Include in-memory storage adapter [1]

Remark:

[1]: For state shared in the same browser tab, but isolated across different browser tab.

Demo: https://react-use-storage-state-demo.surge.sh

Install

## using npm
npm install react-use-storage-state

## or using yarn
yarn add react-use-storage-state

## or using pnpm
pnpm install react-use-storage-state

Typescript Signature

export default useStorageState

export function useStorageState<T>(
  key: string,
  initialState: T | (() => T),
  storageArea?: Storage // default is localStorage
): [state: T, setState: (newState: T | ((prevState: T) => T)) => void];

export function createMemoryStorage(): Storage;

Usage

import React from 'react'
import { useStorageState } from 'react-use-storage-state'

const Example = () => {
  const [state, setState] = useStorageState('counter', 1)
  function inc() {
    setState(state + 1)
  }
  return (
    <button onClick={inc}>
      {state}
    </button>
  )
}

Details see DemoApp.tsx

License

This project is licensed with BSD-2-Clause

This is free, libre, and open-source software. It comes down to four essential freedoms [ref]:

  • The freedom to run the program as you wish, for any purpose
  • The freedom to study how the program works, and change it so it does your computing as you wish
  • The freedom to redistribute copies so you can help others
  • The freedom to distribute copies of your modified versions to others