Window: метод scrollBy()

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

Метод Window.scrollBy() прокручивает документ в окне на указанную величину.

Синтаксис

js
scrollBy(x-coord, y-coord)
scrollBy(options)

Параметры

  • x-coord смещение в пикселях по горизонтали.
  • y-coord смещение в пикселях по вертикали.

- или -

options

Объект, содержащий следующие свойства:

top

Указывает количество пикселей по оси Y для прокрутки окна или элемента.

left

Указывает количество пикселей по оси X для прокрутки окна или элемента.

behavior

Указывает, нужно ли анимировать прокрутку плавно (smooth), быстрым перемещением (instant) или предоставить выбор браузеру (auto, по умолчанию).

Возвращаемое значение

Нет (undefined).

Примеры

Для прокрутки вниз страницы:

js
window.scrollBy(0, window.innerHeight);

Для прокрутки вверх:

js
window.scrollBy(0, -window.innerHeight);

С использованием options:

js
window.scrollBy({
  top: 100,
  left: 100,
  behavior: "smooth",
});

Примечания

window.scrollBy() прокручивает страницу на указанное количество пикселей, в то время как метод window.scroll() прокручивает к абсолютной позиции в документе. Смотрите также window.scrollByLines() и window.scrollByPages().

Спецификации

Specification
CSSOM View Module
# dom-window-scrollby

Совместимость с браузерами