Element: wheel event

{{APIRef("UI Events")}}

The wheel event fires when the user rotates a wheel button on a pointing device (typically a mouse). It is also fired for related devices that simulate wheel actions, such as trackpads and mouse balls.

This event replaces the non-standard deprecated {{domxref("Element/mousewheel_event", "mousewheel")}} event.

Don't confuse the wheel event with the {{domxref("Element/scroll_event", "scroll")}} event:

• A wheel event doesn't necessarily dispatch a scroll event. For example, the element may be unscrollable at all. Zooming actions using the wheel or trackpad also fire wheel events (with {{domxref("MouseEvent/ctrlKey", "ctrlKey")}} set to true).
• A scroll event isn't necessarily triggered by a wheel event. Elements can also be scrolled by using the keyboard, dragging a scrollbar, or using JavaScript.
• Even when the wheel event does trigger scrolling, the delta* values in the wheel event don't necessarily reflect the content's scrolling direction.

Therefore, do not rely on the wheel event's delta* properties to get the scrolling direction. Instead, detect value changes of {{domxref("Element.scrollLeft", "scrollLeft")}} and {{domxref("Element.scrollTop", "scrollTop")}} of the target in the scroll event.

The wheel event is cancelable. In some browsers, only the first wheel event in a sequence is cancelable, and later events are non-cancelable. If the event is canceled, no scrolling or zooming is performed. This may cause performance issues as the browser has to wait for every wheel event to be processed before actually scrolling the content. You can avoid this by setting passive: true when calling {{domxref("EventTarget.addEventListener", "addEventListener()")}}, which may cause the browser to generate non-cancelable wheel events.

Syntax

Use the event name in methods like {{domxref("EventTarget.addEventListener", "addEventListener()")}}, or set an event handler property.

addEventListener("wheel", (event) => { })

onwheel = (event) => { }

Event type

A {{domxref("WheelEvent")}}. Inherits from {{domxref("MouseEvent")}}, {{domxref("UIEvent")}} and {{domxref("Event")}}.

{{InheritanceDiagram("WheelEvent")}}

Event properties

This interface inherits properties from its ancestors, {{DOMxRef("MouseEvent")}}, {{DOMxRef("UIEvent")}}, and {{DOMxRef("Event")}}.

• {{DOMxRef("WheelEvent.deltaX")}} {{ReadOnlyInline}}

  • : Returns a double representing the horizontal scroll amount.

• {{DOMxRef("WheelEvent.deltaY")}} {{ReadOnlyInline}}

  • : Returns a double representing the vertical scroll amount.

• {{DOMxRef("WheelEvent.deltaZ")}} {{ReadOnlyInline}}

  • : Returns a double representing the scroll amount for the z-axis.

• {{DOMxRef("WheelEvent.deltaMode")}} {{ReadOnlyInline}}

  • : Returns an unsigned long representing the unit of the delta* values' scroll amount. Permitted values are:

    Constant	Value	Description
    WheelEvent.DOM_DELTA_PIXEL	0x00	The delta* values are specified in pixels.
    WheelEvent.DOM_DELTA_LINE	0x01	The delta* values are specified in lines. Each mouse click scrolls a line of content, where the method used to calculate line height is browser dependent.
    WheelEvent.DOM_DELTA_PAGE	0x02	The delta* values are specified in pages. Each mouse click scrolls a page of content.

• {{DOMxRef("WheelEvent.wheelDelta")}} {{ReadOnlyInline}} {{deprecated_inline}}

  • : Returns an integer (32-bit) representing the distance in pixels.

• {{DOMxRef("WheelEvent.wheelDeltaX")}} {{ReadOnlyInline}} {{deprecated_inline}}

  • : Returns an integer representing the horizontal scroll amount.

• {{DOMxRef("WheelEvent.wheelDeltaY")}} {{ReadOnlyInline}} {{deprecated_inline}}

  • : Returns an integer representing the vertical scroll amount.

Examples

Scaling an element via the wheel

This example shows how to scale an element using the mouse (or other pointing device) wheel.

<div>Scale me with your mouse wheel.</div>

body {
  min-height: 100vh;
  margin: 0;
  display: flex;
  align-items: center;
  justify-content: center;
}

div {
  width: 105px;
  height: 105px;
  background: #ccddff;
  padding: 5px;
}

let scale = 1;
const el = document.querySelector("div");

function zoom(event) {
  event.preventDefault();

  scale += event.deltaY * -0.01;

  // Restrict scale
  scale = Math.min(Math.max(0.125, scale), 4);

  // Apply scale transform
  el.style.transform = `scale(${scale})`;
}

el.onwheel = zoom;

{{EmbedLiveSample("Scaling_an_element_via_the_wheel", 700, 300)}}

addEventListener equivalent

The event handler can also be set up using the {{domxref("EventTarget/addEventListener", "addEventListener()")}} method:

el.addEventListener("wheel", zoom, { passive: false });

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• {{domxref("WheelEvent")}}