Element: scrollend event
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
The scrollend
event fires when element scrolling has completed.
Scrolling is considered completed when the scroll position has no more pending updates and the user has completed their gesture.
Scroll position updates include smooth or instant mouse wheel scrolling, keyboard scrolling, scroll-snap events, or other APIs and gestures which cause the scroll position to update. User gestures like touch panning or trackpad scrolling aren't complete until pointers or keys have released. If the scroll position did not change, then no scrollend event fires.
For detecting when scrolling inside a Document is complete, see the scrollend
event of Document
.
Syntax
Use the event name in methods like addEventListener()
, or set an event handler property.
addEventListener("scrollend", (event) => {});
onscrollend = (event) => {};
Event type
A generic Event
.
Example
Using scrollend
with an event listener
The following example shows how to use the scrollend
event to detect when the user has stopped scrolling:
<div id="scroll-box">
<p id="scroll-box-title">Scroll me!</p>
<p id="large-element"></p>
</div>
<p id="output">Waiting on scroll events...</p>
const element = document.querySelector("div#scroll-box");
const output = document.querySelector("p#output");
element.addEventListener("scroll", (event) => {
output.textContent = "scroll event fired, waiting for scrollend...";
});
element.addEventListener("scrollend", (event) => {
output.textContent = "scrollend event fired!";
});
Using onscrollend
event handler property
The following example shows how to use the onscrollend
event handler property to detect when the user has stopped scrolling:
<div id="scroll-box">
<p id="scroll-box-title">Scroll me!</p>
<p id="large-element"></p>
</div>
<p id="output">Waiting on scroll events...</p>
const element = document.querySelector("div#scroll-box");
const output = document.querySelector("p#output");
element.onscroll = (event) => {
output.textContent = "Element scroll event fired, waiting for scrollend...";
};
element.onscrollend = (event) => {
output.textContent = "Element scrollend event fired!";
};
Specifications
Specification |
---|
CSSOM View Module # eventdef-document-scrollend |
HTML Standard # handler-onscrollend |
Browser compatibility
BCD tables only load in the browser