Skip to main content

screen

Screen and viewport dimensions, orientation, and Fullscreen API helpers.

Import: @rtorcato/browser-common/screen

๐Ÿ“– MDN: Screen ยท ๐Ÿ“Š caniuse: fullscreen

Exampleโ€‹

import {
getScreenWidth,
getViewportWidth,
isLandscape,
enterFullscreen,
exitFullscreen,
isFullscreen,
} from '@rtorcato/browser-common/screen'

const w = getScreenWidth()
if (isLandscape()) renderWide()

button.addEventListener('click', () => {
if (isFullscreen()) {
exitFullscreen()
} else {
enterFullscreen()
}
})

Exportsโ€‹

  • getScreenWidth() โ€” screen width in pixels, or undefined outside a browser
  • getScreenHeight() โ€” screen height in pixels, or undefined outside a browser
  • getViewportWidth() โ€” viewport width (window.innerWidth), or undefined outside a browser
  • getViewportHeight() โ€” viewport height (window.innerHeight), or undefined outside a browser
  • isLandscape() โ€” true if viewport is wider than tall
  • isPortrait() โ€” true if viewport is taller than or equal to wide
  • enterFullscreen(element?) โ€” requests fullscreen for an element (defaults to document.documentElement)
  • exitFullscreen() โ€” exits fullscreen if active
  • isFullscreen() โ€” true if the document currently has a fullscreen element

See the API reference for full signatures.