IdleDetector.screenState

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 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

Specification
Idle Detection API
# api-idledetector-screenstate

Browser compatibility

BCD tables only load in the browser