Skip to main content

@rtorcato/browser-common / fullscreen

fullscreen

Functions​

enterFullscreen()​

enterFullscreen(element?): Promise<void> | undefined

Defined in: fullscreen/index.ts:13

Requests the browser to enter fullscreen mode for a given element.

Parameters​

element?​

HTMLElement

The element to make fullscreen (defaults to document.documentElement).

Returns​

Promise<void> | undefined

A promise that resolves when fullscreen is entered, or undefined if not supported.

Remarks​

Must be called from a user gesture handler.

Example​

import { enterFullscreen } from '@rtorcato/browser-common/fullscreen'
button.addEventListener('click', () => enterFullscreen(video))

exitFullscreen()​

exitFullscreen(): Promise<void> | undefined

Defined in: fullscreen/index.ts:32

Exits fullscreen mode if currently active.

Returns​

Promise<void> | undefined

A promise that resolves when fullscreen is exited, or undefined if not supported.

Example​

import { exitFullscreen } from '@rtorcato/browser-common/fullscreen'
await exitFullscreen()

isFullscreen()​

isFullscreen(): boolean | undefined

Defined in: fullscreen/index.ts:48

Checks if the browser is currently in fullscreen mode.

Returns​

boolean | undefined

True if in fullscreen, false otherwise, or undefined if not in a browser.

Example​

import { isFullscreen } from '@rtorcato/browser-common/fullscreen'
if (isFullscreen()) showExitButton()

onFullscreenChange()​

onFullscreenChange(callback): () => void

Defined in: fullscreen/index.ts:66

Adds a listener for fullscreen change events.

Parameters​

callback​

() => void

The callback to run on fullscreen change.

Returns​

A function to remove the event listener.

() => void

Example​

import { onFullscreenChange } from '@rtorcato/browser-common/fullscreen'
const off = onFullscreenChange(() => console.log('changed'))
off()