CKTIS / HTML
onpageswap — Behandlung eines ausgehenden Dokuments während der Navigation
Das Attribut onpageswap auf body legt den Window-Handler für das Ereignis pageswap fest. Dieses Ereignis betrifft das ausgehende Dokument während einer Navigation; es meldet nicht, dass eine neue Seite angezeigt wird.
Version: WHATWG HTML Living Standard; index snapshot date recorded separately
Syntax
<body onpageswap="JavaScript statements">onpageswap ist ein Inhaltsattribut, das JavaScript-Code für einen Handler des Ereignisses pageswap enthält. Auf dem Element body konfiguriert es den Handler von Window, nicht einen unabhängigen Handler dieses Elements. Es ist kein boolesches Attribut: Sein Wert ist Code, wobei der Parameter event das Ereignis bereitstellt.
Der Browser kann pageswap im Fenster des bisherigen Dokuments auslösen, wenn dieses durch die Navigation nicht mehr aktiv ist. Das Dokument muss dazu nicht entladen werden: Das Ereignis kann auch ausgelöst werden, wenn der Browser das Dokument im Zurück-/Vorwärts-Cache (bfcache) behält. Das tatsächliche Ereignis verwendet die Schnittstelle PageSwapEvent; seine Eigenschaft viewTransition kann eine View Transition bereitstellen oder den Wert null haben. Verwechsle dieses Ereignis nicht mit pagereveal, das den Beginn der Darstellung eines Dokuments betrifft. pageswap dient nicht dazu, eine Navigation abzubrechen.
Das Attribut auf body und die Eigenschaft window.onpageswap konfigurieren denselben Handler: Eine neue Funktionszuweisung ersetzt die vorherige. Die Alternative window.addEventListener('pageswap', handler) fügt unabhängige Handler hinzu, ohne diese Eigenschaft zu ersetzen. Eine Content Security Policy kann Code in Attributen blockieren; verwende in diesem Fall ein zulässiges externes Skript.
Das Beispielskript gibt nur die Ergebnisse zweier Prüfungen in der Konsole aus: ob body das Attribut onpageswap hat und ob window die Eigenschaft onpageswap bereitstellt. Das Skript löst kein Ereignis aus und startet keine Navigation. Die Ausgabe bestätigt daher nicht, dass der im Attribut definierte Handler ausgeführt wird.
Beispiele
<!doctype html>
<html lang="en">
<head><meta charset="utf-8"><title>Body onpageswap handler</title></head>
<body onpageswap="document.body.dataset.received = event.type">
<script>
console.log('onpageswap attribute present: ' + document.body.hasAttribute('onpageswap'));
console.log('onpageswap event property available: ' + ('onpageswap' in window));
</script>
</body>
</html>
Ergebnis
onpageswap attribute present: true onpageswap event property available: true
Der angezeigte Code und das angegebene Ergebnis wurden in einer isolierten Umgebung mit der im Prüfnachweis für genau diese Version dokumentierten Methode verifiziert.