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
No theme set
Detected from your system settings
import { usePreferredColorScheme } from '@siberiacancode/reactuse';
import { MonitorIcon, MoonIcon, SunIcon } from 'lucide-react';
const Demo = () => {
const preferredColorScheme = usePreferredColorScheme();
return (
<section className='flex flex-col items-center gap-3 p-8'>
<div className='bg-muted text-foreground flex size-12 items-center justify-center rounded-full'>
{preferredColorScheme === 'light' && <SunIcon className='size-5' />}
{preferredColorScheme === 'dark' && <MoonIcon className='size-5' />}
{preferredColorScheme === 'no-preference' && <MonitorIcon className='size-5' />}
</div>
<div className='flex flex-col items-center gap-1 text-center'>
{preferredColorScheme === 'light' && (
<p className='text-foreground text-sm font-medium'>Light mode is on</p>
)}
{preferredColorScheme === 'dark' && (
<p className='text-foreground text-sm font-medium'>Dark mode is on</p>
)}
{preferredColorScheme === 'no-preference' && (
<p className='text-foreground text-sm font-medium'>No theme set</p>
)}
<p className='text-muted-foreground text-xs'>Detected from your system settings</p>
</div>
</section>
);
};
export default Demo;
Installation
pnpm add @siberiacancode/reactuseUsage
const colorScheme = usePreferredColorScheme();Type Declarations
export type UsePreferredColorSchemeReturn = 'dark' | 'light' | 'no-preference';API
Returns
UsePreferredColorSchemeReturnContributors
ddebabinhhywaxppPitohu
Last updated on