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
Welcome back 👋Here's everything you can do
Get started fast
Powerful hooks
Magic by default
import { useMount } from '@siberiacancode/reactuse';
import { RocketIcon, SparklesIcon, ZapIcon } from 'lucide-react';
import { useState } from 'react';
import { cn } from '@/utils/lib';
const STEPS = [
{ icon: RocketIcon, title: 'Get started fast' },
{ icon: ZapIcon, title: 'Powerful hooks' },
{ icon: SparklesIcon, title: 'Magic by default' }
];
const Demo = () => {
const [started, setStarted] = useState(false);
useMount(() => {
const timeoutId = setTimeout(setStarted, 1000, true);
return () => clearTimeout(timeoutId);
});
return (
<section className='flex min-h-72 w-full max-w-sm flex-col items-center justify-center p-4'>
<div
className={cn(
'flex flex-col items-center text-center transition-transform duration-700 ease-out',
started ? '-translate-y-2' : 'translate-y-12'
)}
>
<span
className={cn(
'text-foreground text-2xl font-bold transition-all duration-500 ease-out',
started && 'scale-85'
)}
>
Welcome back 👋
</span>
<span className='text-muted-foreground text-sm'>Here's everything you can do</span>
</div>
<div className='mt-6 flex w-full flex-col items-center gap-3'>
{STEPS.map((step, index) => {
const Icon = step.icon;
return (
<div
key={step.title}
className={cn(
'text-muted-foreground flex items-center gap-2 transition-all duration-500 ease-out',
started ? 'translate-y-0 opacity-100' : 'translate-y-3 opacity-0'
)}
style={{ transitionDelay: started ? `${300 + index * 120}ms` : '0ms' }}
>
<Icon className='size-4 shrink-0' />
<span className='text-xs'>{step.title}</span>
</div>
);
})}
</div>
</section>
);
};
export default Demo;
Installation
pnpm add @siberiacancode/reactuseUsage
useMount(() => console.log('This effect runs on the initial render'));Type Declarations
import type { EffectCallback } from 'react';API
Parameters
| Name | Type | Default | Note |
|---|---|---|---|
| effect | EffectCallback | - | The callback to execute |
Contributors
ddebabinhhywax
Last updated on