Skip to content

Function: requestFullscreen()

ts
function requestFullscreen(element?): Promise<void>;

Requests fullscreen for an element, using the vendor-prefixed API when necessary.

Parameters

ParameterTypeDefault valueDescription
elementElementdocument.documentElementThe element to display in fullscreen. Defaults to document.documentElement.

Returns

Promise<void>

A promise that resolves when fullscreen has been entered.

Example

ts
const el = document.createElement('div')
document.body.appendChild(el)
requestFullscreen(el).catch(e => console.log('blocked:', e.message))

Since

1.0.0

Released under the MIT License.