@technote-space/use-local-storage
TypeScript icon, indicating that this package has built-in type declarations

1.0.6 • Public • Published

useLocalStorage

npm version CI Status codecov CodeFactor License: MIT

React hook to handle localStorage.

Table of Contents

Details

Usage

Install

yarn add @technote-space/use-local-storage

or

npm i @technote-space/use-local-storage

Use

e.g.

import {useCallback} from 'react';
import useLocalStorage from '@technote-space/use-local-storage';
import useMediaQuery from '@material-ui/core/useMediaQuery';

export type ThemeColor = 'light' | 'dark';
const useDarkMode = (): [ThemeColor, () => void, (isDarkMode: boolean) => void] => {
  const [isDarkMode, setDarkMode] = useLocalStorage('is-dark-mode', useMediaQuery('(prefers-color-scheme: dark)'));
  const toggleDarkMode            = useCallback(() => {
    setDarkMode(isDarkMode => !isDarkMode);
  }, []);
  return [isDarkMode ? 'dark' : 'light', toggleDarkMode, setDarkMode];
};

export default useDarkMode;

Author

GitHub (Technote)
Blog

Readme

Keywords

Package Sidebar

Install

npm i @technote-space/use-local-storage

Weekly Downloads

2

Version

1.0.6

License

MIT

Unpacked Size

7.38 kB

Total Files

7

Last publish

Collaborators

  • technote