This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The DeviceProximityEvent interface provides information about the distance of a nearby physical object using the proximity sensor of a device.

Properties

DeviceProximityEvent.max Read only
The maximum sensing distance the sensor is able to report, in centimeters.
DeviceProximityEvent.min Read only
The minimum sensing distance the sensor is able to report, in centimeters. Ususally zero.
DeviceProximityEvent.value Read only
The current device proximity, in centimeters.

Examples

window.addEventListener('deviceproximity', function(event) {
  console.log("value: " + event.value, "max: " + event.max, "min: " + event.min);
});

Specifications

Specification Status Comment
Proximity Sensor
The definition of 'Proximity Events' in that specification.
Working Draft Initial specification

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidEdge MobileFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
Basic support
ExperimentalNon-standard
Chrome No support NoEdge ? Firefox Full support 62
Notes Disabled
Full support 62
Notes Disabled
Notes See bug 1462308.
Disabled From version 62: this feature is behind the device.sensors.proximity.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.
No support ? — 61
IE No support NoOpera No support NoSafari No support NoWebView Android No support NoChrome Android No support NoEdge Mobile ? Firefox Android Full support 62
Notes Disabled
Full support 62
Notes Disabled
Notes See bug 1462308.
Disabled From version 62: this feature is behind the device.sensors.proximity.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.
No support 15 — 61
Opera Android No support NoSafari iOS No support NoSamsung Internet Android ?
max
ExperimentalNon-standard
Chrome No support NoEdge ? Firefox Full support 62
Notes Disabled
Full support 62
Notes Disabled
Notes See bug 1462308.
Disabled From version 62: this feature is behind the device.sensors.proximity.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.
No support ? — 61
IE No support NoOpera No support NoSafari No support NoWebView Android No support NoChrome Android No support NoEdge Mobile ? Firefox Android Full support 62
Notes Disabled
Full support 62
Notes Disabled
Notes See bug 1462308.
Disabled From version 62: this feature is behind the device.sensors.proximity.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.
No support 15 — 61
Opera Android No support NoSafari iOS No support NoSamsung Internet Android ?
min
ExperimentalNon-standard
Chrome No support NoEdge ? Firefox Full support 62
Notes Disabled
Full support 62
Notes Disabled
Notes See bug 1462308.
Disabled From version 62: this feature is behind the device.sensors.proximity.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.
No support ? — 61
IE No support NoOpera No support NoSafari No support NoWebView Android No support NoChrome Android No support NoEdge Mobile ? Firefox Android Full support 62
Notes Disabled
Full support 62
Notes Disabled
Notes See bug 1462308.
Disabled From version 62: this feature is behind the device.sensors.proximity.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.
No support 15 — 61
Opera Android No support NoSafari iOS No support NoSamsung Internet Android ?
value
ExperimentalNon-standard
Chrome No support NoEdge ? Firefox Full support 62
Notes Disabled
Full support 62
Notes Disabled
Notes See bug 1462308.
Disabled From version 62: this feature is behind the device.sensors.proximity.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.
No support ? — 61
IE No support NoOpera No support NoSafari No support NoWebView Android No support NoChrome Android No support NoEdge Mobile ? Firefox Android Full support 62
Notes Disabled
Full support 62
Notes Disabled
Notes See bug 1462308.
Disabled From version 62: this feature is behind the device.sensors.proximity.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.
No support 15 — 61
Opera Android No support NoSafari iOS No support NoSamsung Internet Android ?

Legend

Full support  
Full support
No support  
No support
Compatibility unknown  
Compatibility unknown
Experimental. Expect behavior to change in the future.
Experimental. Expect behavior to change in the future.
Non-standard. Expect poor cross-browser support.
Non-standard. Expect poor cross-browser support.
See implementation notes.
See implementation notes.
User must explicitly enable this feature.
User must explicitly enable this feature.

See also

Document Tags and Contributors

Last updated by: mfluehr,