Element: requestFullscreen() method

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

The Element.requestFullscreen() method issues an asynchronous request to make the element be displayed in fullscreen mode.

It's not guaranteed that the element will be put into full screen mode. If permission to enter full screen mode is granted, the returned Promise will resolve and the element will receive a fullscreenchange event to let it know that it's now in full screen mode. If permission is denied, the promise is rejected and the element receives a fullscreenerror event instead. If the element has been detached from the original document, then the document receives these events instead.

Syntax

js
requestFullscreen()
requestFullscreen(options)

Parameters

options Optional

An object that controls the behavior of the transition to fullscreen mode. The available options are:

Controls whether or not to show navigation UI while the element is in fullscreen mode. The default value is "auto", which indicates that the browser should decide what to do.

"hide"

The browser's navigation interface will be hidden and the entire dimensions of the screen will be allocated to the display of the element.

"show"

The browser will present page navigation controls and possibly other user interface; the dimensions of the element (and the perceived size of the screen) will be clamped to leave room for this user interface.

"auto"

The browser will choose which of the above settings to apply. This is the default value.

screen Optional

Specifies on which screen you want to put the element in fullscreen mode. This takes a ScreenDetailed object as a value, representing the chosen screen.

Return value

A Promise which is resolved with a value of undefined when the transition to full screen is complete.

Exceptions

Rather than throw a traditional exception, the requestFullscreen() procedure announces error conditions by rejecting the Promise it has returned. The rejection handler receives one of the following exception values:

TypeError

The TypeError exception may be delivered in any of the following situations:

  • The document containing the element isn't fully active; that is, it's not the current active document.
  • The element is not contained by a document.
  • The element is not permitted to use the fullscreen feature, either because of Permissions Policy configuration or other access control features.
  • The element and its document are the same node.
  • The element is a popover that is already being shown via HTMLElement.showPopover().

Security

Transient user activation is required. The user has to interact with the page or a UI element in order for this feature to work.

Usage notes

Compatible elements

An element that you wish to place into fullscreen mode has to meet a small number of simple requirements: