Document.fullscreen

Deprecated

This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

The obsolete Document interface's fullscreen read-only property reports whether or not the document is currently displaying content in full-screen mode.

Although this property is read-only, it will not throw if it is modified (even in strict mode); the setter is a no-operation and it will be ignored.

Note: Since this property is deprecated, you can determine if full-screen mode is active on the document by checking to see if Document.fullscreenElement is not null.

Syntax

var isFullScreen = document.fullscreen;

Value

A Boolean value which is true if the document is currently displaying an element in full-screen mode; otherwise, the value is false.

Example

This simple function reports whether or not full-screen mode is currently active, using the obsolete fullscreen property.

function isDocumentInFullScreenMode() {
  return document.fullscreen;
}

This next example, on the other hand, uses the current fullscreenElement property to determine the same thing:

function isDocumentInFullScreenMode() {
  return document.fullscreenElement !== null;
}

If fullscreenElement isn't null, this returns true, indicating that full-screen mode is in effect.

Specifications

Specification
Fullscreen API Standard (Fullscreen API)
# dom-document-fullscreen

Browser compatibility

BCD tables only load in the browser

See also