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

gritzkoo-test-package

v0.0.1

Published

A react hooks to use useReducer with localStorage persist

Downloads

1

Readme

useLocalStorageReducer

npm version Tag Status License Status Issues Status

A react hook that allows you to use the power of browser localstorage and the useReducer react hook combined!

The API is the same, and you'll see no difference between them!

Example live action

Peek 2021-03-06 15-36

You can try this live version on: https://penseapp-uselocalstoragereduce.web.app/

TL;DR

import { useLocalStorageReducer } from "@penseapp/useLocalStorageReducer";

export interface ExampleContextInterface {
  field1: string;
}

export type ExampleAction = UPDATE_STATE; // Your reducers used in switch

const [stateExample, dispatchExample] = useLocalStorageReducer<
  ExampleContextInterface,
  ExampleAction
>(
  "localStorage-key",
  Reducer,
  exampleInitialState,
  60 * 60 // 1 hour
);

How to install

yarn add @penseapp/uselocalstoragereducer

or

npm i @penseapp/uselocalstoragereducer

How to use

You need to implement the reducer/provider on your side. If you want a suggestion to organize the useLocalStorageReducer, please check the files inside the folder playground/src/ExampleContext. And look at the file ExampleContext.tsx

import { useLocalStorageReducer } from "@penseapp/useLocalStorageReducer";

Simple change the useReducer to useLocalStorageReducer on any hooks and it's done. Now you can reload your browser and your state will maintein

- import React, { useReducer } from "react";
+ import React from "react";
+ import { useLocalStorageReducer } from "@penseapp/useLocalStorageReducer";

const App: React.FC = () => {
-  const [state, setstate] = useReducer(reducer, initialState);
+  const [state, setstate] = useLocalStorageReducer<I, A>('keyName', reducer, initialState, false);
// I: Your object
// A: Your action

  return (
    <>
      Your React component...
    </>
  );
};

export default App;

API / Props

| Name | Type | Required | Default | Description | | ------------ | --------------- | -------- | ------------------ | -------------------------------------------------------- | | key | string | true | | Key name from localStorage (Should be unique) | | reducer | React Reducer | true | | https://reactjs.org/docs/hooks-reference.html#usereducer | | initialValue | any (Generic) | true | | Same as the useReducer hook | | expire | number or false | false | 60 * 30 (seconds) | Time in seconds to expiry (false to infinite) |

localStorage expire

This lib use as dependecy the expired-storage, so you can controll your state by how much time it should persist on localStorage

You have two options:

  • Set the time in seconds
  • Set false to infinite

Examples

import Reducer from "your-reducer";

// Never expires (infinite)
const [state, setstate] = useLocalStorageReducer<boolean>(
  "keyName",
  Reducer,
  { field1: "example" },
  false
);

// Expires in 1 minute
const [state, setstate] = useLocalStorageReducer<boolean>(
  "keyName",
  Reducer,
  { field1: "example" },
  60
);

// Expires in 1 hour
const [state, setstate] = useLocalStorageReducer<boolean>(
  "keyName",
  Reducer,
  { field1: "example" },
  60 * 60 * 1
); // 3600 seconds

// Expires in 12 hours
const [state, setstate] = useLocalStorageReducer<boolean>(
  "keyName",
  Reducer,
  { field1: "example" },
  60 * 60 * 12
); // 43200 seconds

Running local

Git clone this repository

git clone [email protected]:penseapp/useLocalStorageReducer.git

Go to repository folder

cd useLocalStorageReducer

Install and start playground repository

yarn && yarn install:playground && yarn start:playground