Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / JavaScript

PopStateEvent.state — estado da entrada do histórico

PopStateEvent.state permite ler o estado associado à entrada do histórico ativada durante um evento popstate. Saiba o que significa null e porque guardar um estado é diferente de navegar no histórico.

Versão: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support

Sintaxe

event.state

PopStateEvent.state é uma propriedade só de leitura, acessível através de event.state. Num evento de navegação, contém uma cópia dos dados guardados por history.pushState() ou history.replaceState() na entrada que acabou de ser ativada, não na entrada que está a ser abandonada. Se não existir um estado guardado, o valor é null; verifique-o antes de ler os campos.

Chamar history.pushState() ou history.replaceState() não dispara, por si só, popstate. O evento está associado à navegação pelo histórico, por exemplo, ao utilizar o botão Anterior. O navegador pode exigir uma interação prévia com a página. Numa aplicação, receba o evento com window.addEventListener("popstate", handler) e restaure a vista com base em event.state.

O exemplo cria deliberadamente dois objetos PopStateEvent e passa-os diretamente a uma função. Não despacha eventos nem altera o histórico. A opção state fornece os dados do primeiro objeto; se for omitida, o valor é null. As linhas esperadas são {"page":2} e null.

Esta é uma API Web do navegador definida pela norma HTML, não uma funcionalidade de uma edição específica de ECMAScript. A MDN indica que a propriedade está amplamente disponível desde julho de 2015 e que o construtor utilizado no exemplo está disponível desde agosto de 2016. A presença do Node 24 num repositório não comprova o suporte destas interfaces.

Exemplos

(() => {
  function describeState(event) {
    console.log(JSON.stringify(event.state));
  }

  describeState(new PopStateEvent("popstate", { state: { page: 2 } }));
  describeState(new PopStateEvent("popstate"));
})();

Resultado

{"page":2}
null

O código apresentado e o resultado declarado foram verificados num ambiente isolado pelo método registado na prova de verificação desta versão exata.

Fontes