Window: método scroll()

Baseline Widely available

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

O método Window.scroll() rola a janela para um local específico no documento.

Sintaxe

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

Parâmetros

  • x-coord é o pixel ao longo do eixo horizontal do documento que você deseja exibido no canto superior esquerdo.
  • y-coord é o pixel ao longo do eixo vertical do documento que você deseja exibido no canto superior esquerdo.

- ou -

options

Um dicionário contendo os seguintes parâmetros:

top

Especifica o número de pixels ao longo do eixo Y para rolar a janela ou elemento.

left

Especifica o número de pixels ao longo do eixo X para rolar a janela ou elemento.

behavior

Determina se a rolagem é instantânea ou animada suavemente. Esta opção é uma string que deve assumir um dos seguintes valores:

  • smooth: a rolagem deve ser animada suavemente
  • instant: a rolagem deve acontecer instantaneamente em um único salto
  • auto: o comportamento de rolagem é determinado pelo valor calculado de scroll-behavior

Valor de retorno

Nenhum (undefined).

Exemplos

html
<!-- coloque o centésimo pixel vertical no topo da janela -->

<button onclick="scroll(0, 100);">clique para rolar até o 100º pixel</button>

Usando options:

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

Notas

Window.scrollTo() é efetivamente o mesmo que este método. Para parente rolagem, veja Window.scrollBy(), Window.scrollByLines(), e Window.scrollByPages().

Para elementos de rolagem, consulte Element.scrollTop e Element.scrollLeft.

Especificações

Specification
CSSOM View Module
# dom-window-scroll

Compatibilidade com navegadores

BCD tables only load in the browser

Veja também