Skip to main content

@rtorcato/browser-common / screen

screen

Functions​

getScreenWidth()​

getScreenWidth(): number | undefined

Defined in: screen/index.ts:10

Gets the current screen width in pixels.

Returns​

number | undefined

The screen width, or undefined if not in a browser.

Example​

import { getScreenWidth } from '@rtorcato/browser-common/screen'
const w = getScreenWidth()

getScreenHeight()​

getScreenHeight(): number | undefined

Defined in: screen/index.ts:26

Gets the current screen height in pixels.

Returns​

number | undefined

The screen height, or undefined if not in a browser.

Example​

import { getScreenHeight } from '@rtorcato/browser-common/screen'
const h = getScreenHeight()

getViewportWidth()​

getViewportWidth(): number | undefined

Defined in: screen/index.ts:42

Gets the current viewport width in pixels.

Returns​

number | undefined

The viewport width, or undefined if not in a browser.

Example​

import { getViewportWidth } from '@rtorcato/browser-common/screen'
const w = getViewportWidth()

getViewportHeight()​

getViewportHeight(): number | undefined

Defined in: screen/index.ts:58

Gets the current viewport height in pixels.

Returns​

number | undefined

The viewport height, or undefined if not in a browser.

Example​

import { getViewportHeight } from '@rtorcato/browser-common/screen'
const h = getViewportHeight()

isLandscape()​

isLandscape(): boolean | undefined

Defined in: screen/index.ts:74

Checks if the screen is currently in landscape orientation.

Returns​

boolean | undefined

True if landscape, false if portrait, undefined if not in a browser.

Example​

import { isLandscape } from '@rtorcato/browser-common/screen'
if (isLandscape()) renderWide()

isPortrait()​

isPortrait(): boolean | undefined

Defined in: screen/index.ts:90

Checks if the screen is currently in portrait orientation.

Returns​

boolean | undefined

True if portrait, false if landscape, undefined if not in a browser.

Example​

import { isPortrait } from '@rtorcato/browser-common/screen'
if (isPortrait()) renderStacked()

enterFullscreen()​

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

Defined in: screen/index.ts:107

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.

Example​

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

exitFullscreen()​

exitFullscreen(): Promise<void> | undefined

Defined in: screen/index.ts:126

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/screen'
await exitFullscreen()

isFullscreen()​

isFullscreen(): boolean | undefined

Defined in: screen/index.ts:142

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/screen'
if (isFullscreen()) showExitHint()