TheUserActivation 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

UserActivation.hasBeenActiveRead only

Indicates whether the current window has sticky user activation.

UserActivation.isActiveRead only

Indicates whether the current window has transient user activation.

Description

An object of this type is accessed via thenavigator.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:

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

SeeFeatures 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

Usenavigator.userActivation to access theUserActivation object, and thenUserActivation.isActive to check whether the user is currently interacting with the page (Transient activation).

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

Checking if a user gesture was ever performed

UseUserActivation.hasBeenActive to check whether the user has ever interacted with the page (Sticky activation).

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

Specifications

Browser compatibility

See also

• navigator.userActivation
• Features gated by user activation