Use Window Scroll

import { UseWindowScrollDemos } from '@docs/demos'; import { Layout } from '@/layout'; import { MDX_DATA } from '@/mdx';

export default Layout(MDX_DATA.useWindowScroll);

Usage

The use-window-scroll hook returns the current scroll position and a function to scroll smoothly to a given position:

Definition

interface UseWindowScrollPosition {
  x: number;
  y: number;
}

type UseWindowScrollTo = (position: Partial<UseWindowScrollPosition>) => void;
type UseWindowScrollReturnValue = [UseWindowScrollPosition, UseWindowScrollTo];

function useWindowScroll(): UseWindowScrollReturnValue;

Exported types

The UseWindowScrollTo, UseWindowScrollPosition, and UseWindowScrollReturnValue types are exported from @mantine/hooks;

import type { UseWindowScrollTo, UseWindowScrollPosition, UseWindowScrollReturnValue } from '@mantine/hooks';