dom / latest / idledetector / userstate.html /

IdleDetector.userState

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The userState read-only property of the IdleDetector interface returns a string indicating whether the user has interacted with the device since the call to start().

Value

Either "active" or "idle" 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

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
userState
94
94
No
No
80
No
94
94
No
66
No
17.0

© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/IdleDetector/userState