References

Beginner-friendly references for web development, with live, editable examples.

The HTML onpageswap event

Event Updated
Quick answer

The HTML onpageswap attribute runs JavaScript when the page is about to be swapped during a cross-document navigation. It is an inline handler for the pageswap event; in modern code prefer addEventListener('pageswap', …).

Overview

The onpageswap event attribute runs JavaScript just before a cross-document navigation swaps the page. In JavaScript the event itself is named pageswap. Drop the on prefix when you call addEventListener.

It is a window-level event rather than one tied to a particular element, so it is handled on window. These events cover the page lifecycle, navigation, network status, messaging and similar global concerns.

You can wire this up with the inline onpageswap HTML attribute, but the modern, recommended approach is window.addEventListener('pageswap', handler) in JavaScript. That keeps behavior out of your markup, lets you attach several handlers to the same event, and makes them easy to remove. The inline attribute is fine for quick demos.

Syntax

<body onpageswap="handler()">…</body>

window.addEventListener('pageswap', handler);

Best practices

  • Prefer window.addEventListener('pageswap', handler) over the inline onpageswap attribute; it separates behavior from markup and allows multiple handlers.
  • Attach these on window with addEventListener rather than as <body> attributes.
  • Keep these handlers fast; they run at moments that affect the whole page.
  • Remove listeners you no longer need to avoid leaks in long-lived pages.

Frequently asked questions

What is the onpageswap event?
It runs JavaScript just before a cross-document navigation swaps the page. In JavaScript the event is named pageswap.
Where do I attach this event?
On window: these are global events, not tied to a single element.
Can I use it as a body attribute?
Yes. An onpageswap attribute on <body> is forwarded to the Window object, so the handler is registered on window rather than on the body element itself.
Should I use the onpageswap attribute or addEventListener?
Prefer window.addEventListener('pageswap', …) in JavaScript. The inline onpageswap attribute works but mixes behavior into the markup and allows only one handler per element.
onpageshow onpaste