ContextQMD
Back to Content

UserActivation

files/en-us/web/api/useractivation/index.md

latest2.3 KB
Original Source

{{APIRef("HTML DOM")}}

The UserActivation interface provides information about whether a user is currently interacting with the page, or has completed an interaction since page load.

This API is only available in the window context and not exposed to workers.

Instance properties

  • {{domxref("UserActivation.hasBeenActive")}} {{ReadOnlyInline}}
    • : Indicates whether the current window has sticky user activation.
  • {{domxref("UserActivation.isActive")}} {{ReadOnlyInline}}
    • : Indicates whether the current window has transient user activation.

Description

An object of this type is accessed via the {{domxref("navigator.userActivation")}} property, and can be used to query information about a window's user activation state.

A user activation either implies that the user is currently interacting with the page, or has completed an interaction since page load. User activation can be triggered by a button click, pointer touch, or some other user interaction with the page.

There are two kinds of window user activation states:

  • {{Glossary("Transient activation")}} (user is currently interacting with the page) and
  • {{Glossary("Sticky activation")}} (user has interacted at least once since page load).

See Features gated by user activation for more information and a list of APIs that require either sticky or transient user activation.

Examples

Checking if a user gesture was recently performed

Use {{domxref("navigator.userActivation")}} to access the UserActivation object, and then {{domxref("UserActivation.isActive")}} to check whether the user is currently interacting with the page ({{Glossary("Transient activation")}}).

js
if (navigator.userActivation.isActive) {
  // proceed to request playing media, for example
}

Checking if a user gesture was ever performed

Use {{domxref("UserActivation.hasBeenActive")}} to check whether the user has ever interacted with the page ({{Glossary("Sticky activation")}}).

js
if (navigator.userActivation.hasBeenActive) {
  // proceed with auto-playing an animation, for example
}

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also