Type:
Anything
A plain object of data that will be passed to the event handler.
handler
A function to execute each time the event is triggered.
This page describes the
unload
event. For the
.unload()
method removed in jQuery 3.0, see
.unload()
.
The
unload
event is sent to the
window
element when the user navigates away from the page. This could mean one of many things. The user could have clicked on a link to leave the page, or typed in a new URL in the address bar. The forward and back buttons will trigger the event. Closing the browser window will cause the event to be triggered. Even a page reload will first create an
unload
event.
The exact handling of the
unload
event has varied from version to version of browsers. For example, some versions of Firefox trigger the event when a link is followed, but not when the window is closed. In practical usage, behavior should be tested on all supported browsers and contrasted with the similar
beforeunload
event.
Any
unload
event handler should be bound to the
window
object:
This event is available so that scripts can perform cleanup when the user leaves the page. Most browsers will ignore calls to
alert()
,
confirm()
and
prompt()
inside the event handler. The string you return may be used in a confirmation dialog, but not all browsers support this. It is not possible to cancel the
unload
event with
.preventDefault()
.