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-persisted-state

v1.0.0

Published

Easily persist your states across sessions with minimal effort. `react-persisted-state` extends the familiar `useState` hook to allow state persistence in `localStorage`, `sessionStorage`, `cookies`, or **even through custom adapters**. This library is de

Downloads

56

Readme

react-persisted-state

Easily persist your states across sessions with minimal effort. react-persisted-state extends the familiar useState hook to allow state persistence in localStorage, sessionStorage, cookies, or even through custom adapters. This library is designed to be fully flexible, allowing you to maintain state persistence with identical usability to React's own state hook, including inferred typing, state setting functions, initial state definitions, and more.

Features

  • Seamless State Persistence: Automatically persists state across page reloads and sessions.
  • Plug-and-Play: Uses localStorage by default but easily switches to sessionStorage, cookies or other custom adapters.
  • Custom Storage Adapters: Extend persistence to any storage by implementing IPersistedAdapter.
  • Fully Typed: TypeScript support out-of-the-box, with inferred types for your state.
  • Minimal API: Designed to be a drop-in replacement for React's useState.

Installation

Using npm

npm install react-persisted-state

Using yarn

yarn add react-persisted-state

Using pnpm

pnpm add react-persisted-state

Usage Examples

Here are various ways to use react-persisted-state, demonstrating its flexibility:

Basic Usage with localStorage (Default)

import { usePersistedState } from 'react-persisted-state';

const [count, setCount] = usePersistedState('countKey', 0);

Using sessionStorage

import { usePersistedState } from 'react-persisted-state';

const [userSession] = usePersistedState<string | null>('userSessionKey', null, 'sessionStorage');

/**
 * Or you can use directly `window.sessionStorage`
 */
const [userSession] = usePersistedState<string | null>('userSessionKey', null, window.sessionStorage);

Using cookies

import { usePersistedState, CookiePersistedAdapter } from 'react-persisted-state';

const [theme, setTheme] = usePersistedState<Theme>('theme', 'light', 'cookies');

/**
 * Or you can a direct instance of CookiePersistedAdapter
 */
const [theme, setTheme] = usePersistedState<Theme>('theme', 'light', new CookiePersistedAdapter());

Using a Custom Persisted Adapter

// Create your implementation
import { usePersistedState, IPersistedAdapter } from 'react-persisted-state';

class CustomPersistedAdapter implements IPersistedAdapter {
  getItem(key: string): string {
    // fetch your data and return in JSON format
  }

  setItem(key: string, value: string): void {
    // store your data in JSON format
  }

  removeItem(key: string): void {
    // remove your data
  }
}

// And use it
const [state, setState] = usePersistedState('stateKey', null, new CustomPersistedAdapter());

Removing Persisted State

import { usePersistedState, CookiePersistedAdapter } from 'react-persisted-state';

const [theme, setTheme, removePersistedTheme] = usePersistedState<Theme>('theme', 'light');

/**
 * This will remove the persisted theme from localStorage
 */
removePersistedTheme();

Customizing Storage Behavior

Implement IPersistedAdapter to customize storage methods, allowing you to use any storage mechanism your prefer. The adapter requires three methods: getItem, setItem and removeItem. Look at the CustomPersistedAdapter above example to see how to implement it.

Contributing

Contributions are welcome! Whether it's feature requests, bug reports, or pull requests, feel free to contribute. For more details, check out CONTRIBUTING.md.