MDN self-hosted library · e01.org

IdleDetector: screenState property

Idle Detection APIwindowanddedicated

Open notebook · 1 cells web-api-instance-property upstream source

Idle Detection APIwindow_and_dedicated

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

Value

Either "locked" or "unlocked" if 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

Browser compatibility