Window: unload event
====================

**Deprecated:** This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

**Warning:** Developers should avoid using this event. See "Usage notes" below.

The **`unload`** event is fired when the document or a child resource is being unloaded.

It is fired after:

* `beforeunload` (cancelable event)
* `pagehide`

The document is in the following state:

* All the resources still exist (img, iframe etc.)
* Nothing is visible anymore to the end user
* UI interactions are ineffective (`window.open`, `alert`, `confirm`, etc.)
* An error won't stop the unloading workflow

Please note that the unload event also follows the document tree: parent frame unload will happen **before** child frame `unload` (see example below).

Syntax
------

Use the event name in methods like `addEventListener()`, or set an event handler property.


```js
addEventListener("unload", (event) => {});
onunload = (event) => {};
```

Event type
----------

A generic `Event`.

Event handler aliases
---------------------

In addition to the `Window` interface, the event handler property `onunload` is also available on the following targets:

* `HTMLBodyElement`
* `HTMLFrameSetElement`
* `SVGSVGElement`
Usage notes
-----------

Developers should avoid using this event.

Especially on mobile, the `unload` event is not reliably fired. For example, the `unload` event is not fired at all in the following scenario:

1. A mobile user visits your page.
2. The user then switches to a different app.
3. Later, the user closes the browser from the app manager.

Also, the `unload` event is not compatible with the back/forward cache (bfcache), because many pages using this event assume that the page will not continue to exist after the event is fired. To combat this, some browsers (such as Firefox) will not place pages in the bfcache if they have unload listeners, and this is bad for performance. Others, such as Chrome, will not fire the `unload` when a user navigates away.

The best event to use to signal the end of a user's session is the `visibilitychange` event. In browsers that don't support `visibilitychange` the next-best alternative is the `pagehide` event, which is also not fired reliably, but which is bfcache-compatible.

If you're specifically trying to detect page unload events, it's best to listen for the `pagehide` event.

See the Page Lifecycle API guide for more information about the problems associated with the `unload` event.

Examples
--------


```html
<!doctype html>
<html lang="en-US">
  <head>
    <meta charset="UTF-8" />
    <title>Parent Frame</title>
    <script>
 window.addEventListener("beforeunload", (event) => {
 console.log("I am the 1st one.");
 });
 window.addEventListener("unload", (event) => {
 console.log("I am the 3rd one.");
 });
 </script>
  </head>
  <body>
    <iframe src="child-frame.html"></iframe>
  </body>
</html>
```


Below, the content of `child-frame.html`:


```html
<!doctype html>
<html lang="en-US">
  <head>
    <meta charset="UTF-8" />
    <title>Child Frame</title>
    <script>
 window.addEventListener("beforeunload", (event) => {
 console.log("I am the 2nd one.");
 });
 window.addEventListener("unload", (event) => {
 console.log("I am the 4th and last one…");
 });
 </script>
  </head>
  <body>
    ☻
  </body>
</html>
```


When the parent frame is unloaded, events will be fired in the order described by the `console.log()` messages.

Specifications
--------------

| Specification |
| --- |
| HTML Standard # event-unload |
| HTML Standard # handler-window-onunload |

Browser compatibility
---------------------

BCD tables only load in the browser with JavaScript enabled. Enable JavaScript to view data.

See also
--------

* Related events: `DOMContentLoaded`, `readystatechange`, `load`
* Unloading Documents — unload a document
* The `visibilitychange` event.
* Don't lose user and app state, use Page Visibility explains in
 detail why you should use `visibilitychange`, not
 `beforeunload`/`unload`.
* Page Lifecycle API gives best-practices guidance on handling
 page lifecycle behavior in your web applications.
* PageLifecycle.js: a JavaScript library that deals with cross-browser inconsistencies in page lifecycle behavior.
* Back/forward cache explains what the back/forward cache is, and its implications for various page lifecycle events.