use-window-scroll

Subscribe to window scroll and scroll smoothly to given position

Import

Source

View source code

Docs

Edit this page

Package

@asuikit/hooks

Usage

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

Scroll position x: 0, y: 0

import { useWindowScroll } from '@asuikit/hooks';
import { Button, Text, Group } from '@asuikit/core';

function Demo() {
  const [scroll, scrollTo] = useWindowScroll();

  return (
    <Group position="center">
      <Text>
        Scroll position x: {scroll.x}, y: {scroll.y}
      </Text>
      <Button onClick={() => scrollTo({ y: 0 })}>Scroll to top</Button>
    </Group>
  );
}

Definition

function useWindowScroll(): readonly [
  { x: number; y: number },
  (position: { x?: number; y?: number }) => void
];

Go back

use-window-event – @asuikit/hooks

Up next

use-did-update – @asuikit/hooks

Build fully functional accessible web applications faster than ever

About

Contribute About Mantine Changelog Releases

Community

Chat on Discord Follow on Twitter Follow on GitHub GitHub discussions

Project

Mantine UI Documentation GitHub organization npm organization

Built by Vitaly Rtishchev and these awesome people

Join Discord community

Follow Mantine on Twitter