elements
lifecycle
browser
- useAudio
- useBattery
- useBluetooth
- useBreakpoints
- useBroadcastChannel
- useBrowserLocation
- useClipboard
- useCopy
- useCssVar
- useDisplayMedia
- useDocumentEvent
- useDocumentTitle
- useDocumentVisibility
- useEventListener
- useEventSource
- useEyeDropper
- useFavicon
- useFileSystemAccess
- useFps
- useFullscreen
- useGamepad
- useGeolocation
- useMeasure
- useMediaControls
- useMediaQuery
- useMemory
- useNetwork
- useObjectUrl
- useOnline
- useOtpCredential
- usePermission
- usePictureInPicture
- usePointerLock
- usePostMessage
- useRaf
- useShare
- useSpeechRecognition
- useSpeechSynthesis
- useSticky
- useVibrate
- useVirtualKeyboard
- useWakeLock
- useWebSocket
utilities
state
- useBoolean
- useControllableState
- useCookie
- useCookies
- useCounter
- useCycleList
- useDefault
- useDisclosure
- useField
- useHash
- useList
- useLocalStorage
- useMap
- useMask
- useMergedRef
- useObject
- useOffsetPagination
- useQueue
- useRafState
- useRefState
- useSessionStorage
- useSet
- useStateHistory
- useStep
- useStorage
- useToggle
- useUrlSearchParam
- useUrlSearchParams
- useValidatedState
- useWizard
user
sensors
- useDeviceMotion
- useDeviceOrientation
- useHotkeys
- useIdle
- useInfiniteScroll
- useIntersectionObserver
- useKeyboard
- useKeyPress
- useKeysPressed
- useMouse
- useMutationObserver
- useOrientation
- usePageLeave
- useParallax
- usePerformanceObserver
- useResizeObserver
- useScroll
- useScrollIntoView
- useScrollTo
- useSwipe
- useTextSelection
- useVisibility
- useWindowEvent
- useWindowFocus
- useWindowScroll
- useWindowSize
Email notificationsHow often you get updates
import { useLocalStorage } from '@siberiacancode/reactuse';
import { BellIcon, ChevronDownIcon } from 'lucide-react';
const FREQUENCY_OPTIONS = [
{ value: 'live', label: 'Real-time' },
{ value: 'daily', label: 'Daily digest' },
{ value: 'weekly', label: 'Weekly summary' },
{ value: 'off', label: 'Off' }
];
const Demo = () => {
const settingLocalStorage = useLocalStorage('reactuse-demo-notify', 'daily');
return (
<section className='border-border flex w-full max-w-sm min-w-0 flex-col gap-2 rounded-xl border p-2 md:max-w-md'>
<div className='flex w-full min-w-0 flex-col gap-4 p-4 sm:flex-row sm:items-start sm:justify-between'>
<div className='flex min-w-0 items-center gap-3'>
<BellIcon className='text-muted-foreground size-6 shrink-0' />
<div className='flex min-w-0 flex-col gap-0.5'>
<span className='text-sm font-medium'>Email notifications</span>
<span className='text-muted-foreground text-xs'>How often you get updates</span>
</div>
</div>
<div className='relative w-full sm:w-auto'>
<select
className='w-full sm:min-w-44'
value={settingLocalStorage.value}
onChange={(event) => settingLocalStorage.set(event.target.value)}
>
{FREQUENCY_OPTIONS.map((option) => (
<option key={option.value} value={option.value}>
{option.label}
</option>
))}
</select>
<ChevronDownIcon className='text-muted-foreground pointer-events-none absolute top-1/2 right-2 size-4 -translate-y-1/2' />
</div>
</div>
</section>
);
};
export default Demo;
This hook uses localStorage browser api to provide enhanced functionality. Make sure to check for compatibility with different browsers when using this api
Installation
pnpm add @siberiacancode/reactuseUsage
const { value, set, remove } = useLocalStorage('key', 'value');Type Declarations
import type { UseStorageInitialValue, UseStorageOptions } from '../useStorage/useStorage';API
Parameters
| Name | Type | Default | Note |
|---|---|---|---|
| key | string | - | The key of the storage |
| initialValue | UseStorageInitialValue<Value> | - | The initial value of the storage |
| options | UseStorageOptions<Value> | - | The options of the storage |
Contributors
ddebabinhhywax
Last updated on