Logoreact-pre-hooks
DocumentationDocumentationContributionContribution (opens in a new tab)
GitHubGitHub (opens in a new tab)
  • Getting Started
    • useAnimationFrame
    • useArray
    • useAsyncCallback
    • useAudioAnalyser
    • useBoolean
    • useClickAway
    • useClipboard
    • useClock
    • useCounter
    • useDebouncedState
    • useDragAndDrop
    • useEventListener
    • useFileDropArea
    • useForceUpdate
    • useFullscreen
    • useGamepad
    • useGeolocation
    • useGridLayout
    • useIntersectionObserver
    • useInterval
    • useInView
    • useIsomorphicEffect
    • useKeyboard
    • useLocalStorage
    • useMediaDevices
    • useMediaQuery
    • useMousePosition
    • useMutationObserver
    • useNetworkState
    • useOrientation
    • usePageVisibility
    • usePointers
    • usePreferredLanguage
    • useRect
    • useResizeObserver
    • useScreenCapture
    • useScrollDirection
    • useScrollPosition
    • useScrollThreshold
    • useSelection
    • useSessionStorage
    • useSwiping
    • useTimeout
    • useToggle
    • useViewport
    • useWorker

On This Page

  • Type Definitions
Question? Give us feedback → (opens in a new tab)Edit this page on GitHub →View source code
Documentation
Hooks
useScrollPosition

useScrollPosition

Track the scroll position or progress of the window or a target element.

Scroll to see the progress.

Type Definitions

const useScrollPosition: <T extends HTMLElement = HTMLDivElement>(ref?: React.RefObject<T> | null) => {
    x: number;
    y: number;
    progressX: number;
    progressY: number;
    ref: React.RefObject<T>;
};
useScrollDirectionuseScrollThreshold

© Copyright 2023-2024 Malki Abderrahmane