Web/API/VisualViewport

This is an experimental technologyCheck the Browser compatibility table carefully before using this in production.

The VisualViewport interface of the Visual Viewport API represents the visual viewport for a given window. For a page containing iframes, each iframe, as well as the containing page, will have a unique window object. Each window on a page will have a unique VisualViewport representing the properties associated with that window.

You can get a window's visual viewport using Window.visualViewport.

Note: Only the top-level window has a visual viewport that's distinct from the layout viewport. Therefore, it's generally only the VisualViewport object of the top-level window that's useful. For an <iframe>, visual viewport metrics like VisualViewport.width always correspond to layout viewport metrics like document.documentElement.clientWidth.

Properties

VisualViewport also inherits properties from its parent, EventTarget.

VisualViewport.offsetLeft Read only: Returns the offset of the left edge of the visual viewport from the left edge of the layout viewport in CSS pixels.
VisualViewport.offsetTop Read only: Returns the offset of the top edge of the visual viewport from the top edge of the layout viewport in CSS pixels.
VisualViewport.pageLeft Read only: Returns the x coordinate of the visual viewport relative to the initial containing block origin of the top edge in CSS pixels.
VisualViewport.pageTop Read only: Returns the y coordinate of the visual viewport relative to the initial containing block origin of the top edge in CSS pixels.
VisualViewport.width Read only: Returns the width of the visual viewport in CSS pixels.
VisualViewport.height Read only: Returns the height of the visual viewport in CSS pixels.
VisualViewport.scale Read only: Returns the pinch-zoom scaling factor applied to the visual viewport.

Events

Listen to these events using addEventListener() or by assigning an event listener to the relevant oneventname property of this interface.

resize: Fired when the visual viewport is resized. Also available via the VisualViewport.onresize property.
scroll: Fired when the visual viewport is scrolled. Also available via the VisualViewport.onscroll property.

Examples

Hiding an overlaid box on zoom

This example, taken from the Visual Viewport README, shows how to write a simple bit of code that will hide an overlaid box (which might contain an advert, say) when the user zooms in. This is a nice way to improve the user experience when zooming in on pages. A live sample is also available.

var bottomBar = document.getElementById('bottombar');
var viewport = window.visualViewport;

function resizeHandler() {
   if (viewport.scale > 1.3)
     bottomBar.style.display = "none";
   else
     bottomBar.style.display = "block";
}
 
window.visualViewport.addEventListener('resize', resizeHandler);

Simulating position: device-fixed

This example, also taken from the Visual Viewport README, shows how to use this API to simulate position: device-fixed, which fixes elements to the visual viewport. A live sample is also available.

var bottomBar = document.getElementById('bottombar');
var viewport = window.visualViewport;
function viewportHandler() {
  var layoutViewport = document.getElementById('layoutViewport');

  // Since the bar is position: fixed we need to offset it by the visual
  // viewport's offset from the layout viewport origin.
  var offsetLeft = viewport.offsetLeft;
  var offsetTop = viewport.height
              - layoutViewport.getBoundingClientRect().height
              + viewport.offsetTop;

  // You could also do this by setting style.left and style.top if you
  // use width: 100% instead.
  bottomBar.style.transform = 'translate(' +
                              offsetLeft + 'px,' +
                              offsetTop + 'px) ' +
                              'scale(' + 1/viewport.scale + ')'
}
window.visualViewport.addEventListener('scroll', viewportHandler);
window.visualViewport.addEventListener('resize', viewportHandler);

Note: This technique should be used with care; emulating position: device-fixed in this way can result in the fixed element flickering during scrolling.

Specifications

Specification	Status	Comment
Visual Viewport APIThe definition of 'VisualViewport' in that specification.	Draft	Initial definition.

Browser compatibility

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`VisualViewport` Experimental'	Chrome Full support 61	Edge Full support 79	Firefox Full support 63 Disabled' Full support 63 Disabled' Disabled' From version 63: this feature is behind the `dom.visualviewport.enabled` preference (needs to be set to `true`). To change preferences in Firefox, visit about:config.	IE No support No	Opera Full support 48	Safari Full support 13	WebView Android Full support 61	Chrome Android Full support 61	Firefox Android Full support 68 Full support 68 Full support 63 Disabled' Disabled' From version 63: this feature is behind the `dom.visualviewport.enabled` preference (needs to be set to `true`). To change preferences in Firefox, visit about:config.	Opera Android Full support 45	Safari iOS Full support 13	Samsung Internet Android Full support 8.0
`height` Experimental'	Chrome Full support 61	Edge Full support 79	Firefox Full support 63 Disabled' Full support 63 Disabled' Disabled' From version 63: this feature is behind the `dom.visualviewport.enabled` preference (needs to be set to `true`). To change preferences in Firefox, visit about:config.	IE No support No	Opera Full support 48	Safari Full support 13	WebView Android Full support 61	Chrome Android Full support 61	Firefox Android Full support 68 Full support 68 Full support 63 Disabled' Disabled' From version 63: this feature is behind the `dom.visualviewport.enabled` preference (needs to be set to `true`). To change preferences in Firefox, visit about:config.	Opera Android Full support 45	Safari iOS Full support 13	Samsung Internet Android Full support 8.0
`offsetLeft` Experimental'	Chrome Full support 61	Edge Full support 79	Firefox Full support 63 Disabled' Full support 63 Disabled' Disabled' From version 63: this feature is behind the `dom.visualviewport.enabled` preference (needs to be set to `true`). To change preferences in Firefox, visit about:config.	IE No support No	Opera Full support 48	Safari Full support 13	WebView Android Full support 61	Chrome Android Full support 61	Firefox Android Full support 68 Full support 68 Full support 63 Disabled' Disabled' From version 63: this feature is behind the `dom.visualviewport.enabled` preference (needs to be set to `true`). To change preferences in Firefox, visit about:config.	Opera Android Full support 45	Safari iOS Full support 13	Samsung Internet Android Full support 8.0
`offsetTop` Experimental'	Chrome Full support 61	Edge Full support 79	Firefox Full support 63 Disabled' Full support 63 Disabled' Disabled' From version 63: this feature is behind the `dom.visualviewport.enabled` preference (needs to be set to `true`). To change preferences in Firefox, visit about:config.	IE No support No	Opera Full support 48	Safari Full support 13	WebView Android Full support 61	Chrome Android Full support 61	Firefox Android Full support 68 Full support 68 Full support 63 Disabled' Disabled' From version 63: this feature is behind the `dom.visualviewport.enabled` preference (needs to be set to `true`). To change preferences in Firefox, visit about:config.	Opera Android Full support 45	Safari iOS Full support 13	Samsung Internet Android Full support 8.0
`onresize` Experimental'	Chrome Full support 62 Full support 62 Partial support 61	Edge Full support 79	Firefox Full support 66 Disabled' Full support 66 Disabled' Disabled' From version 66: this feature is behind the `dom.visualviewport.enabled` preference (needs to be set to `true`). To change preferences in Firefox, visit about:config.	IE No support No	Opera Full support 49 Full support 49 Partial support 48	Safari Full support 13	WebView Android Full support 62 Full support 62 Partial support 61	Chrome Android Full support 62 Full support 62 Partial support 61	Firefox Android Full support 68 Full support 68 Full support 66 Disabled' Disabled' From version 66: this feature is behind the `dom.visualviewport.enabled` preference (needs to be set to `true`). To change preferences in Firefox, visit about:config.	Opera Android Full support 46 Full support 46 Partial support 45	Safari iOS Full support 13	Samsung Internet Android Full support 8.0 Full support 8.0 Partial support 8.0
`onscroll` Experimental'	Chrome Full support 62 Full support 62 Partial support 61	Edge Full support 79	Firefox Full support 66 Disabled' Full support 66 Disabled' Disabled' From version 66: this feature is behind the `dom.visualviewport.enabled` preference (needs to be set to `true`). To change preferences in Firefox, visit about:config.	IE No support No	Opera Full support 49 Full support 49 Partial support 48	Safari Full support 13	WebView Android Full support 62 Full support 62 Partial support 61	Chrome Android Full support 62 Full support 62 Partial support 61	Firefox Android Full support 68 Full support 68 Full support 66 Disabled' Disabled' From version 66: this feature is behind the `dom.visualviewport.enabled` preference (needs to be set to `true`). To change preferences in Firefox, visit about:config.	Opera Android Full support 46 Full support 46 Partial support 45	Safari iOS Full support 13	Samsung Internet Android Full support 8.0 Full support 8.0 Partial support 8.0
`pageLeft` Experimental'	Chrome Full support 61	Edge Full support 79	Firefox Full support 63 Disabled' Full support 63 Disabled' Disabled' From version 63: this feature is behind the `dom.visualviewport.enabled` preference (needs to be set to `true`). To change preferences in Firefox, visit about:config.	IE No support No	Opera Full support 48	Safari Full support 13	WebView Android Full support 61	Chrome Android Full support 61	Firefox Android Full support 68 Full support 68 Full support 63 Disabled' Disabled' From version 63: this feature is behind the `dom.visualviewport.enabled` preference (needs to be set to `true`). To change preferences in Firefox, visit about:config.	Opera Android Full support 45	Safari iOS Full support 13	Samsung Internet Android Full support 8.0
`pageTop` Experimental'	Chrome Full support 61	Edge Full support 79	Firefox Full support 63 Disabled' Full support 63 Disabled' Disabled' From version 63: this feature is behind the `dom.visualviewport.enabled` preference (needs to be set to `true`). To change preferences in Firefox, visit about:config.	IE No support No	Opera Full support 48	Safari Full support 13	WebView Android Full support 61	Chrome Android Full support 61	Firefox Android Full support 68 Full support 68 Full support 63 Disabled' Disabled' From version 63: this feature is behind the `dom.visualviewport.enabled` preference (needs to be set to `true`). To change preferences in Firefox, visit about:config.	Opera Android Full support 45	Safari iOS Full support 13	Samsung Internet Android Full support 8.0
`resize` event Experimental'	Chrome Full support 62 Full support 62 Partial support 61	Edge Full support 79	Firefox Full support 66 Disabled' Full support 66 Disabled' Disabled' From version 66: this feature is behind the `dom.visualviewport.enabled` preference (needs to be set to `true`). To change preferences in Firefox, visit about:config.	IE No support No	Opera Full support 49 Full support 49 Partial support 48	Safari Full support 13	WebView Android Full support 62 Full support 62 Partial support 61	Chrome Android Full support 62 Full support 62 Partial support 61	Firefox Android Full support 68 Full support 68 Full support 66 Disabled' Disabled' From version 66: this feature is behind the `dom.visualviewport.enabled` preference (needs to be set to `true`). To change preferences in Firefox, visit about:config.	Opera Android Full support 46 Full support 46 Partial support 45	Safari iOS Full support 13	Samsung Internet Android Full support 8.0 Full support 8.0 Partial support 8.0
`scale` Experimental'	Chrome Full support 61	Edge Full support 79	Firefox Full support 63 Disabled' Full support 63 Disabled' Disabled' From version 63: this feature is behind the `dom.visualviewport.enabled` preference (needs to be set to `true`). To change preferences in Firefox, visit about:config.	IE No support No	Opera Full support 48	Safari Full support 13	WebView Android Full support 61	Chrome Android Full support 61	Firefox Android Full support 68 Full support 68 Full support 63 Disabled' Disabled' From version 63: this feature is behind the `dom.visualviewport.enabled` preference (needs to be set to `true`). To change preferences in Firefox, visit about:config.	Opera Android Full support 45	Safari iOS Full support 13	Samsung Internet Android Full support 8.0
`scroll` event Experimental'	Chrome Full support 62 Full support 62 Partial support 61	Edge Full support 79	Firefox Full support 66 Disabled' Full support 66 Disabled' Disabled' From version 66: this feature is behind the `dom.visualviewport.enabled` preference (needs to be set to `true`). To change preferences in Firefox, visit about:config.	IE No support No	Opera Full support 49 Full support 49 Partial support 48	Safari Full support 13	WebView Android Full support 62 Full support 62 Partial support 61	Chrome Android Full support 62 Full support 62 Partial support 61	Firefox Android Full support 68 Full support 68 Full support 66 Disabled' Disabled' From version 66: this feature is behind the `dom.visualviewport.enabled` preference (needs to be set to `true`). To change preferences in Firefox, visit about:config.	Opera Android Full support 46 Full support 46 Partial support 45	Safari iOS Full support 13	Samsung Internet Android Full support 8.0 Full support 8.0 Partial support 8.0
`width` Experimental'	Chrome Full support 61	Edge Full support 79	Firefox Full support 63 Disabled' Full support 63 Disabled' Disabled' From version 63: this feature is behind the `dom.visualviewport.enabled` preference (needs to be set to `true`). To change preferences in Firefox, visit about:config.	IE No support No	Opera Full support 48	Safari Full support 13	WebView Android Full support 61	Chrome Android Full support 61	Firefox Android Full support 68 Full support 68 Full support 63 Disabled' Disabled' From version 63: this feature is behind the `dom.visualviewport.enabled` preference (needs to be set to `true`). To change preferences in Firefox, visit about:config.	Opera Android Full support 45	Safari iOS Full support 13	Samsung Internet Android Full support 8.0

Legend

Full support: Full support
No support: No support
Experimental. Expect behavior to change in the future.': Experimental. Expect behavior to change in the future.
User must explicitly enable this feature.': User must explicitly enable this feature.