zikwall/use-localforage

React Hook for localForage - improves the offline experience of your web app by using asynchronous storage (IndexedDB or WebSQL) with a simple, localStorage-like API

use localForage

localForage is a fast and simple storage library for JavaScript

Installation

• $ yarn add @zikwall/use-localforage

How to use

import { useLocalForage } from "@zikwall/use-localforage";

interface User {
    name: string;
    lastname: string;
    age: number;
}

function App() {
    const [ userValue, setUserValue, removeUserValue ] = useLocalForage<User>('user', {...});

    let onUpdate = () => {
        setUserValue({...});
    };

    let onRemove = () => {
        removeUserValue();
    };

    return (
        <div className="example component">
            <button onClick={onUpdate}>Click for update user properties</button>
            <button onClick={onRemove}>Click for remove user properties</button>

            <p>Name is: {userValue?.name}</p>
            <p>Lastname is: {userValue?.lastname}</p>
            <p>Age is: {userValue?.age}</p>
        </div>
    );
}

Tests

• $ yarn test