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
Hold on
import { useTimeout } from '@siberiacancode/reactuse';
const DELAY = 5000;
const Demo = () => {
const timeout = useTimeout(() => {}, DELAY);
return (
<section className='flex w-full max-w-md flex-col items-center gap-6 p-8'>
<div
key={String(timeout.ready)}
className='animate-in fade-in slide-in-from-bottom-2 duration-500'
>
<span className='text-foreground text-5xl font-bold tracking-tight'>
{timeout.ready ? "You're awesome" : 'Hold on'}
</span>
</div>
<div className='bg-muted h-1 w-32 overflow-hidden rounded-full'>
<div
className='bg-foreground h-full origin-left'
style={{ animation: `progress ${DELAY}ms linear forwards` }}
/>
</div>
<style>{`
@keyframes progress {
from { transform: scaleX(0); }
to { transform: scaleX(1); }
}
`}</style>
</section>
);
};
export default Demo;
Installation
pnpm add @siberiacancode/reactuseUsage
const { clear, ready } = useTimeout(() => {}, 5000);Type Declarations
interface UseTimeoutReturn {
/** Timeout is ready state value */
ready: boolean;
/** Function to clear timeout */
clear: () => void;
}API
Parameters
| Name | Type | Default | Note |
|---|---|---|---|
| callback | () => void | - | The function to be executed after the timeout |
| delay | number | - | The delay in milliseconds before the timeout executes the callback function |
Returns
UseTimeoutReturnContributors
ddebabinhhywaxttriangle
Last updated on