IdleDetector: screenState property

{{securecontext_header}}{{APIRef("Idle Detection API")}}{{SeeCompatTable}}{{AvailableInWorkers("window_and_dedicated")}}

The screenState read-only property of the {{domxref("IdleDetector")}} interface returns a string indicating whether the screen is locked, one of "locked" or "unlocked".

Value

Either "locked" or "unlocked" if {{domxref("IdleDetector.start()")}} has been called, or null otherwise.

Examples

In the following example, the change callback prints the status of userState and screenState to the console.

idleDetector.addEventListener("change", () => {
  const userState = idleDetector.userState;
  const screenState = idleDetector.screenState;
  console.log(`Idle change: ${userState}, ${screenState}.`);
});

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}