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
Move your cursor — the dot follows
import type { MouseEvent } from 'react';
import { useThrottleState } from '@siberiacancode/reactuse';
interface Point {
x: number;
y: number;
}
const Demo = () => {
const [point, setPoint] = useThrottleState<Point | undefined>(undefined, 100);
const onMouseMove = (event: MouseEvent<HTMLDivElement>) => {
const rect = event.currentTarget.getBoundingClientRect();
setPoint({ x: event.clientX - rect.left, y: event.clientY - rect.top });
};
const onMouseLeave = () => setPoint(undefined);
return (
<section className='flex w-full max-w-md flex-col p-4'>
<div
className='border-border bg-card relative h-72 w-full overflow-hidden rounded-xl border'
onMouseLeave={onMouseLeave}
onMouseMove={onMouseMove}
>
{point && (
<span
className='bg-primary pointer-events-none absolute size-4 -translate-x-1/2 -translate-y-1/2 rounded-full transition-[left,top] duration-100 ease-out'
style={{ left: point.x, top: point.y }}
/>
)}
<div className='text-muted-foreground pointer-events-none absolute inset-x-0 bottom-3 text-center text-xs'>
Move your cursor — the dot follows
</div>
</div>
</section>
);
};
export default Demo;
Installation
pnpm add @siberiacancode/reactuseUsage
const [throttledValue, setThrottledValue] = useThrottleState(value, 500);API
Parameters
| Name | Type | Default | Note |
|---|---|---|---|
| value | Value | - | The value to be throttled |
| delay | number | - | The delay in milliseconds |
Returns
[Value, (value: Value) => void]Contributors
ddebabin
Last updated on