Fullscreen

external object Fullscreen(source)

Browser-independent functions for working with the standard fullscreen API.

See also

Properties

Link copied to clipboard
external val changeEventName: String

The name of the event on the document that is fired when fullscreen is entered or exited. This event name is intended for use with addEventListener. In your event handler, to determine if the browser is in fullscreen mode or not, use Fullscreen.fullscreen.

Link copied to clipboard
external val element: JsAny

The element that is currently fullscreen, if any. To simply check if the browser is in fullscreen mode or not, use Fullscreen.fullscreen.

Link copied to clipboard
external val enabled: Boolean

Determine whether the browser will allow an element to be made fullscreen, or not. For example, by default, iframes cannot go fullscreen unless the containing page adds an "allowfullscreen" attribute (or prefixed equivalent).

Link copied to clipboard
external val errorEventName: String

The name of the event that is fired when a fullscreen error occurs. This event name is intended for use with addEventListener.

Link copied to clipboard
external val fullscreen: Boolean

Determines if the browser is currently in fullscreen mode.

Functions

Link copied to clipboard
external fun exitFullscreen()

Asynchronously exits fullscreen mode. If the browser is not currently in fullscreen, or if fullscreen mode is not supported by the browser, does nothing.

Link copied to clipboard
external fun requestFullscreen(element: JsAny, vrDevice: JsAny? = definedExternally)

Asynchronously requests the browser to enter fullscreen mode on the given element. If fullscreen mode is not supported by the browser, does nothing.

Link copied to clipboard
external fun supportsFullscreen(): Boolean

Detects whether the browser supports the standard fullscreen API.