Element: webkitmouseforcewillbegin event

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.

Safari for macOS fires the non-standard webkitmouseforcewillbegin event at an Element before firing the initial mousedown event.

This offers the opportunity to tell the system not to trigger any default Force Touch actions if and when the click turns into a Force Touch Events.

To instruct macOS not to engage any default Force Touch actions if the user apply enough pressure to activate a Force Touch event, call preventDefault() on the webkitmouseforcewillbegin event object.

webkitmouseforcewillbegin is a proprietary, WebKit-specific event. It is part of the Force Touch Events feature.

Syntax

Use the event name in methods like addEventListener(), or set an event handler property.

js
addEventListener("webkitmouseforceup", (event) => {});

onwebkitmouseforceup = (event) => {};

Event type

A MouseEvent. Inherits from UIEvent and Event.

Event UIEvent MouseEvent

Event properties

This interface also inherits properties of its parents, UIEvent and Event.

MouseEvent.altKey Read only

Returns true if the alt key was down when the mouse event was fired.

MouseEvent.button Read only

The button number that was pressed (if applicable) when the mouse event was fired.

MouseEvent.buttons Read only

The buttons being pressed (if any) when the mouse event was fired.

MouseEvent.clientX Read only

The X coordinate of the mouse pointer in viewport coordinates.

MouseEvent.clientY Read only

The Y coordinate of the mouse pointer in viewport coordinates.

MouseEvent.ctrlKey Read only

Returns true if the control key was down when the mouse event was fired.

MouseEvent.layerX Read only

Returns the horizontal coordinate of the event relative to the current layer.

MouseEvent.layerY Read only

Returns the vertical coordinate of the event relative to the current layer.

MouseEvent.metaKey Read only

Returns true if the meta key was down when the mouse event was fired.

MouseEvent.movementX Read only

The X coordinate of the mouse pointer relative to the position of the last mousemove event.

MouseEvent.movementY Read only

The Y coordinate of the mouse pointer relative to the position of the last mousemove event.

MouseEvent.offsetX Read only

The X coordinate of the mouse pointer relative to the position of the padding edge of the target node.

MouseEvent.offsetY Read only

The Y coordinate of the mouse pointer relative to the position of the padding edge of the target node.

MouseEvent.pageX Read only

The X coordinate of the mouse pointer relative to the whole document.

MouseEvent.pageY Read only

The Y coordinate of the mouse pointer relative to the whole document.

MouseEvent.relatedTarget Read only

The secondary target for the event, if there is one.

MouseEvent.screenX Read only

The X coordinate of the mouse pointer in screen coordinates.

MouseEvent.screenY Read only

The Y coordinate of the mouse pointer in screen coordinates.

MouseEvent.shiftKey Read only

Returns true if the shift key was down when the mouse event was fired.

MouseEvent.mozInputSource Read only

The type of device that generated the event (one of the MOZ_SOURCE_* constants). This lets you, for example, determine whether a mouse event was generated by an actual mouse or by a touch event (which might affect the degree of accuracy with which you interpret the coordinates associated with the event).

MouseEvent.webkitForce Read only

The amount of pressure applied when clicking.

MouseEvent.x Read only

Alias for MouseEvent.clientX.

MouseEvent.y Read only

Alias for MouseEvent.clientY.

Specifications

Not part of any specification. Apple has a description at the Mac Developer Library.

Browser compatibility

BCD tables only load in the browser

See also