AmbientLightSensor
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The AmbientLightSensor interface of the Sensor APIs returns the current light level or illuminance of the ambient light around the hosting device.
To use this sensor, the user must grant permission to the 'ambient-light-sensor' device sensor through the Permissions API.
This feature may be blocked by a Permissions Policy set on your server.
Constructor
AmbientLightSensor()-
Creates a new
AmbientLightSensorobject.
Instance properties
AmbientLightSensor.illuminanceRead only-
Returns the current light level in lux of the ambient light level around the hosting device.
Instance methods
AmbientLightSensor doesn't have own methods. However, it inherits methods from its parent interfaces, Sensor and EventTarget.
Events
AmbientLightSensor doesn't have own events. However, it inherits events from its parent interface, Sensor.
Example
js
if ("AmbientLightSensor" in window) {
const sensor = new AmbientLightSensor();
sensor.addEventListener("reading", (event) => {
console.log("Current light level:", sensor.illuminance);
});
sensor.addEventListener("error", (event) => {
console.log(event.error.name, event.error.message);
});
sensor.start();
}
Specifications
| Specification |
|---|
| Ambient Light Sensor # ambient-light-sensor-interface |
Browser compatibility
| desktop | mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
AmbientLightSensor
|
|
|
|
|
|
|
|
|
|
|
|
|
AmbientLightSensor() constructor
|
|
|
|
|
|
|
|
|
|
|
|
|
illuminance
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- No support
- No support
- Experimental. Expect behavior to change in the future.
- See implementation notes.
- User must explicitly enable this feature.
- Has more compatibility info.