Nascent Prototype Metaverse

    @rooks/use-localstorage
    TypeScript icon, indicating that this package has built-in type declarations

    4.11.2 • Public • Published

    @rooks/use-localstorage

    Note: Future updates to this package have moved to the main package rooks. All hooks now reside in a single package which you can install using

    npm install rooks
    

    or

    yarn add rooks
    

    Rooks is completely treeshakeable and if you use only 1 of the 50+ hooks in the package, only that hook will be bundled with your code. Your bundle will only contain the hooks that you need. Cheers!

    TitleCard

    Build Status

    About

    Localstorage hook for React. Syncs with localstorage values across components and browser windows automatically.

    Sets and retrieves a key from localStorage and subscribes to it for updates across windows.

    Installation

    npm install --save @rooks/use-localstorage
    

    Importing the hook

    import useLocalstorage from "@rooks/use-localstorage";

    Usage

    function Demo() {
      const [value, set, remove] = useLocalstorage("my-value", 0);
      // Can also be used as {value, set, remove}
    
      return (
        <p>
          Value is {value}
          <button onClick={() => set(value !== null ? value + 1 : 0)}>
            Increment
          </button>
          <button onClick={remove}>Remove </button>
        </p>
      );
    }
    
    render(<Demo />);

    Install

    npm i @rooks/use-localstorage

    DownloadsWeekly Downloads

    350

    Version

    4.11.2

    License

    MIT

    Unpacked Size

    11.1 kB

    Total Files

    13

    Last publish

    Collaborators

    • avatar