katanakit-js / useRequestFullscreen

Function: useRequestFullscreen()

function useRequestFullscreen(target?): Promise<void>;

Defined in: src/infrastructure/viewport/viewport.service.ts:285

Requests fullscreen on the given element (or the document root).

Parameters

Parameter	Type	Description
target?	HTMLElement	The element to make fullscreen (defaults to document.documentElement).

Returns

Promise<void>

Throws

If fullscreen is not supported.

Example

await useRequestFullscreen(videoElement);