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

@gk3000/use-local-storage

v1.0.2

Published

A custom hook to use local storage in React

Downloads

223

Readme

@gk3000/use-local-storage

A simple and reusable React hook for managing localStorage with stateful reactivity. This hook allows you to easily store, retrieve, and clear values from localStorage while keeping them synchronized with your component's state.

Features

  • Persistent Storage: Syncs your component state with localStorage to persist data across page reloads.
  • State Management: Automatically triggers component re-renders when the localStorage value changes.
  • Dynamic Data: Handles various data types (strings, numbers, objects, arrays, etc.) with JSON serialization.
  • Clear Functionality: Easily clear the localStorage entry and reset the state to the initial value.

Installation

You can install the hook via npm:

npm i @gk3000/use-local-storage

or

yarn add @gk3000/use-local-storage

Usage

Import:

import useLocalStorage from '@gk3000/use-local-storage'

Basic example:

import React from 'react';
import useLocalStorage from '@your-username/use-local-storage';

function App() {
  // Use the custom hook to manage localStorage and component state
  const [name, setName, clearName] = useLocalStorage('name', 'Guest');

  return (
    <div>
      <h1>Hello, {name}!</h1>
      <input
        type="text"
        value={name}
        onChange={(e) => setName(e.target.value)}
        placeholder="Enter your name"
      />
      <button onClick={clearName}>Clear Name</button>
    </div>
  );
}

export default App;

Parameters

const [storedValue, setValue, clear] = useLocalStorage(key, initialValue);
  • key (string): The key in localStorage under which the data is stored.
  • initialValue (any): The initial value to use if no existing data is found in localStorage for the given key.

Returns

  • storedValue: The current value stored in localStorage (and React state).
  • setValue: A function to update the value in localStorage and React state.
  • clear: A function to remove the value from localStorage and reset the state to the initialValue.

Advanced Example (Objects and Arrays)

The useLocalStorage hook can handle more complex data structures like arrays and objects:

function App() {
  const [favoriteColors, setFavoriteColors, clearColors] = useLocalStorage('colors', ['Red', 'Blue']);

  const addColor = () => setFavoriteColors(prevColors => [...prevColors, 'Green']);

  return (
    <div>
      <h2>Favorite Colors:</h2>
      <ul>
        {favoriteColors.map((color, index) => (
          <li key={index}>{color}</li>
        ))}
      </ul>
      <button onClick={addColor}>Add Green</button>
      <button onClick={clearColors}>Clear Colors</button>
    </div>
  );
}

Error Handling

The hook safely handles any errors that may occur when interacting with localStorage (e.g., JSON parsing errors, browser restrictions) and falls back to the initial value if necessary.

License

MIT