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-hook-webstorage

v0.0.3

Published

React hooks using WebStorage API like LocalStorage and SessionStorage

Downloads

7

Readme

react-hook-webstorage

react-hook-webstorage offers a collection of React hooks designed to simplify the management of data on top of the Web Storage API and implements LocalStorage and SessionStorage. Whether you're building a small application or a large-scale project, these hooks provide an efficient way to handle persistent data in your React applications.

Components using the following hooks will rerender when another component changes the value of its controlled storage key. This is useful for updating the UI consistently.

Table of Contents

  1. Installation
  2. The hooks
  3. License

Installation

To install react-hook-webstorage, use your preferred package manager:

npm install react-hook-webstorage
# or
yarn add react-hook-webstorage

The hooks

All hooks return an object with the following properties:

  • value: The current value stored in the storage for the specified key.
  • setItem: A function to set a new value for the specified key in the storage.
  • removeItem: A function to remove the value for the specified key from the storage.

useLocalStorage()

import { useLocalStorage } from 'react-hook-webstorage';

function Component() {
  const { value, setItem, removeItem } = useLocalStorage('-key', {
    parse: true,
    fallback: 'default-value',
  });

  return (
    // Your component JSX here
  );
}

useSessionStorage

import { useSessionStorage } from 'react-hook-webstorage';

function Component() {
  const { value, setItem, removeItem } = useSessionStorage('-key', {
    parse: false,
    fallback: null,
  });

  return (
    // Your component JSX here
  );
}

useWebStorage

The useWebStorage hook provides a flexible foundation for creating custom storage solutions based on the Web Storage Interface. This allows developers to extend the library's functionality or implement specific storage requirements. Below is a guide on how to use useWebStorage to build a custom storage solution.

Building Custom Storage with useWebStorage

Creating a Custom Storage Provider

To create a custom storage provider, implement the StorageProvider interface. Here's an example of a custom storage provider for a hypothetical CustomStorage:

import { StorageProvider } from 'react-hook-webstorage';

export const CustomStorageProvider: StorageProvider = {
  get name() {
    return 'custom-storage';
  },
  get storage() {
    // Implement your custom logic to get the storage instance
    // This could be an in-memory storage, a database, or any other custom solution
    return getCustomStorageInstance();
  },
};
Using useWebStorage with Custom Storage to build a custom hook

Now, you can use the useWebStorage hook with your custom storage provider:

import { useWebStorage } from 'react-hook-webstorage';

import { CustomStorageProvider } from './CustomStorageProvider';

export type UseCustomStorageHookOptions<T = unknown> = UseWebStorageHookOptions<T>;
export type UseCustomStorageHookResult<T = unknown> = UseWebStorageHookResult<T>;
export type UseCustomStorageHook = typeof useCustomStorage;

export function useCustomStorage<T = unknown>(
  key: string,
  options: UseCustomStorageHookOptions<T> = {},
): UseCustomStorageHookResult<T> {
  return useWebStorage<T>(CustomStorageProvider, key, options);
}

License

LICENSE (MIT)