Firefox Tomorrow

web api instance property

IdleDetector: userState property

View on MDN ↗

Secure contextLimited availabilityAvailable in workers

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

SpecificationsStandards references are available on the canonical MDN page.

Browser compatibility

Browser compatibilityCompatibility data is available on the canonical MDN page.