This article needs a technical review. How you can help.
Non-standard
This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.
The DOM DOMMouseScroll
event is fired asynchronously when mouse wheel or similar device is operated and the accumulated scroll amount becomes over 1 line or 1 page since last event. It's represented by the MouseScrollEvent
interface.
If you want to prevent the default action of mouse wheel events, it's not enough to handle only this event on Gecko because If scroll amount by a native mouse wheel event is less than 1 line (or less than 1 page when the system setting is by page scroll), other mouse wheel events may be fired without this event.
On Gecko 17 (Firefox 17) or later, you need to call preventDefault()
of wheel
events which must be fired for every native event.
On Gecko 16 or earlier, you need to call preventDefault()
of MozMousePixelScroll
event which must be fired for every native event.
Use standardized wheel
event if available.
- Interface :
MouseScrollEvent
- Synchronicity :asynchronous
- Bubbles : yes
- Target :
Element
,Document
,Window
- Cancelable : yes
- Default action : Scroll, moving history, or zooming in/out
Properties
The event has only one additional property beyond standard events.
detail
The detail
property describes the scroll more precisely, with positive values indicating scrolling downward and negative values indicating scrolling upward.
If the event represents scrolling up by a page, the value of detail
is -32768. If the event indictes scrolling down by a page, the value is +32768. Any other value represents the number of lines to scroll, with the direction indicated by the value's sign.
Note: Trusted events are never sent with a value of 0 for detail
.
Trusted events are never fired with 0.
Note: If the platform's native mouse wheel events only provide scroll distance by pixels, or if the speed can be customized by the user, the value is computed using the line height of the nearest scrollable ancestor element of the event's target. If that element's font size is smaller than mousewheel.min_line_scroll_amount
, that preference's value is used as the line height.
Browser compatibility
Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari |
---|---|---|---|---|---|
Basic support | Not supported | 1.0 (1.7 or earlier) | Not supported | Not supported | Not supported |
Feature | Android | Firefox Mobile (Gecko) | IE Mobile | Opera Mobile | Safari Mobile |
---|---|---|---|---|---|
Basic support | Not supported | 1.0 (1.0) | Not supported | Not supported | Not supported |
See also
MouseScrollEvent
- Gecko's legacy pixel scroll event:
MozMousePixelScroll
- Non-Gecko browsers' legacy mouse wheel event:
mousewheel
- Standardized wheel event:
wheel