The scrollsnapchanging event of the Element interface is fired on the scroll container when the browser determines a new scroll snap target is pending, i.e., it will be selected when the current scroll gesture ends.
Specifically, this event fires during a scrolling gesture, each time the user moves over potential new snap targets. For example, the user could scroll slowly by dragging their finger on a touch screen device, or hold down the mouse button on a scroll bar and move the mouse. scrollsnapchanging can therefore fire multiple times for each scrolling gesture.
However, it does not fire on all potential snap targets for a scrolling gesture that moves over multiple snap targets. Rather, it fires just for the last target that the snapping will potentially rest on.
Syntax
Use the event name in EventTarget/addEventListener:
addEventListener("scrollsnapchanging", (event) => { })
Alternatively, assign to the event handler property of the interface:
onscrollsnapchanging = (event) => { }
Event type
A SnapEvent, which inherits from the generic Event type.
Examples
Basic usage
Let's say we have a main element containing significant content that causes it to scroll:
<main>
</main>
The <main> element can be turned into a scroll container that snaps to its children when scrolled using a combination of the CSS scroll-snap-type property and other properties. For example:
main {
width: 250px;
height: 450px;
overflow: scroll;
scroll-snap-type: block mandatory;
}
The following JavaScript snippet would cause the scrollsnapchanging event to fire on the <main> element when one of its children becomes a pending snap target. In the handler function, we set a pending class on the child referenced by the SnapEvent.snapTargetBlock property, which could be used to style it differently when the event fires.
scrollingElem.addEventListener("scrollsnapchanging", (event) => {
// remove previously-set "pending" classes
const pendingElems = document.querySelectorAll(".pending");
pendingElems.forEach((elem) => {
elem.classList.remove("pending");
});
// Set current pending snap target class to "pending"
event.snapTargetBlock.classList.add("pending");
});
At the start of the function, we select all elements that previously had the pending class applied and remove it, so that only the most recent pending snap target is styled.
Specifications
Browser compatibility
See also
- Element/scrollsnapchange_event event
- Document/scrollend_event event
- SnapEvent
- CSS scroll-snap-type property
- CSS scroll snap module
- Using scroll snap events
- Scroll Snap Events on developer.chrome.com (2024)
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
