Element: scrollIntoViewIfNeeded() method - Web APIs | MDN

Syntax

js

scrollIntoViewIfNeeded()
scrollIntoViewIfNeeded(centerIfNeeded)

Parameters

centerIfNeeded Optional

An optional boolean value with a default of true:

  • If true, the element will be aligned so it is centered within the visible area of the scrollable ancestor.
  • If false, the element will be aligned to the nearest edge of the visible area of the scrollable ancestor. Depending on which edge of the visible area is closest to the element, either the top of the element will be aligned to the top edge of the visible area, or the bottom edge of the element will be aligned to the bottom edge of the visible area.

Return value

None (undefined).

Examples

js

const element = document.getElementById("my-el");

element.scrollIntoViewIfNeeded(); // Centers the element in the visible area
element.scrollIntoViewIfNeeded(false); // Aligns the element to the nearest edge in the visible area

Specifications

Not part of any specification. This is a proprietary, WebKit-specific method.

Browser compatibility

See also

Help improve MDN

Learn how to contribute

This page was last modified on by MDN contributors.