Snap Events
The SnapEvent() constructor creates a new
SnapEvent object instance.
Syntax
new SnapEvent(type, init)
Parameters
type- : A string representing the type of event. For Element/scrollsnapchanging_event events, this is
scrollsnapchanging. For Element/scrollsnapchange_event events, this isscrollsnapchange.
- : A string representing the type of event. For Element/scrollsnapchanging_event events, this is
init- : An object containing the following properties:
snapTargetBlock- : Returns a reference to the element snapped to in the block direction when the event fired, or
nullif scroll snapping only occurs in the inline direction so no element is snapped to in the block direction.
- : Returns a reference to the element snapped to in the block direction when the event fired, or
snapTargetInline- : Returns a reference to the element snapped to in the inline direction when the event fired, or
nullif scroll snapping only occurs in the block direction so no element is snapped to in the inline direction.
- : Returns a reference to the element snapped to in the inline direction when the event fired, or
- : An object containing the following properties:
Examples
A developer would not use this constructor manually. A new SnapEvent object is constructed when a handler is invoked as a result of the Element/scrollsnapchanging_event or Element/scrollsnapchange_event events firing.
For example:
mainElem.addEventListener("scrollsnapchange", (event) => {
// …
// Log a SnapEvent object instance to the console
console.log(event);
});
Specifications
Browser compatibility
See also
- Element/scrollsnapchanging_event event
- Element/scrollsnapchange_event event
- CSS scroll snap module
- Scroll Snap Events on developer.chrome.com (2024)
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
