NavigateEvent.scroll()

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The scroll() method of the NavigateEvent interface can be called to manually trigger the browser-driven scrolling behavior that occurs in response to the navigation, if you want it to happen before the navigation handling has completed.

Syntax

scroll()

Parameters

None.

Return value

undefined.

Exceptions

InvalidStateError DOMException

Thrown if the current Document is not yet active, if the navigation was not intercepted using intercept(), or if the default scroll behavior has already ocurred.

Examples

Handling scrolling using scroll()

In this example of intercepting a navigation, the handler() function starts by fetching and rendering some article content, but then fetches and renders some secondary content afterwards. It makes sense to scroll the page to the main article content as soon as it is available so the user can interact with it, rather than waiting until the secondary content is also rendered. To achieve this, we have added a scroll() call between the two.

navigation.addEventListener('navigate', (event) => {
  if (shouldNotIntercept(navigateEvent)) {
    return;
  } 
  const url = new URL(event.destination.url);

  if (url.pathname.startsWith('/articles/')) {
    event.intercept({
      async handler() {
        const articleContent = await getArticleContent(url.pathname);
        renderArticlePage(articleContent);

        event.scroll();

        const secondaryContent = await getSecondaryContent(url.pathname);
        addSecondaryContent(secondaryContent);
      },
    });
  }
});

Specifications

Specification
Navigation API
# dom-navigateevent-scroll

Browser compatibility

BCD tables only load in the browser

See also