Skip to main content

@rtorcato/browser-common / visualviewport

visualviewport

Interfaces​

VisualViewportInfo​

Defined in: visualviewport/index.ts:16

Information about the current visual viewport.

Properties​

offsetLeft​

offsetLeft: number

Defined in: visualviewport/index.ts:17

offsetTop​

offsetTop: number

Defined in: visualviewport/index.ts:18

width​

width: number

Defined in: visualviewport/index.ts:19

height​

height: number

Defined in: visualviewport/index.ts:20

scale​

scale: number

Defined in: visualviewport/index.ts:21

Functions​

isVisualViewportAvailable()​

isVisualViewportAvailable(): boolean

Defined in: visualviewport/index.ts:9

Checks if the Visual Viewport API is available in the current browser.

Returns​

boolean

Example​

import { isVisualViewportAvailable } from '@rtorcato/browser-common/visualviewport'
if (isVisualViewportAvailable()) trackViewport()

getVisualViewportInfo()​

getVisualViewportInfo(): VisualViewportInfo | null

Defined in: visualviewport/index.ts:33

Gets the current visual viewport's properties, or null if not supported.

Returns​

VisualViewportInfo | null

Example​

import { getVisualViewportInfo } from '@rtorcato/browser-common/visualviewport'
const info = getVisualViewportInfo()
console.log(info?.scale)

onVisualViewportChange()​

onVisualViewportChange(callback): () => void

Defined in: visualviewport/index.ts:56

Adds listeners for visual viewport resize and scroll events. Returns a function to remove the listeners.

Parameters​

callback​

() => void

Function to call on resize or scroll.

Returns​

() => void

Example​

import { onVisualViewportChange } from '@rtorcato/browser-common/visualviewport'
const off = onVisualViewportChange(() => updateLayout())
off()