Gets information about a window.
Returns information about a window's size, document's size, and current scroll position.
This method returns null for sites with SSR.
function getBoundingRect(): Promise<WindowSizeInfo>;import { window } from "@wix/site-window";
// ...
window.getBoundingRect().then((windowSizeInfo) => {
let windowHeight = windowSizeInfo.window.height; // 565
let windowWidth = windowSizeInfo.window.width; // 1269
let documentHeight = windowSizeInfo.document.height; // 780
let documentWidth = windowSizeInfo.document.width; // 1269
let scrollX = windowSizeInfo.scroll.x; // 0
let scrollY = windowSizeInfo.scroll.y; // 120
});This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Gets the current geolocation of a site visitor.
The getCurrentGeolocation() method has the following limitations:
getCurrentGeolocation() with a setTimeout() in case the browser is set to not detect the locale. Adding the timeout lets you handle the unfulfilled promise.function getCurrentGeolocation(): Promise<CurrentGeolocation>;import { window } from "@wix/site-window";
// ...
window
.getCurrentGeolocation()
.then((obj) => {
let timestamp = obj.timestamp; // 1495027186984
let latitude = obj.coords.latitude; // 32.0971036
let longitude = obj.coords.longitude; // 34.774391099999995
let altitude = obj.coords.altitude; // null
let accuracy = obj.coords.accuracy; // 29
let altAccuracy = obj.coords.altitudeAccuracy; // null
let heading = obj.coords.heading; // null
let speed = obj.coords.speed; // null
})
.catch((error) => {
let errorMsg = error;
});This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Gets the data sent by a router to a page as part of its response.
When you define a router and its functionality in the router() method, you can include data in the router's response.
This data can then be accessed in the code of the routed page by calling the getRouterData() method. If you call this method from a non-router page or a router
page that wasn't sent any data, the method returns null.
function getRouterData(): Promise<object>;import { window } from "@wix/site-window";
// ...
let routerData = await window.getRouterData();This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Opens a lightbox added by an app.
The openAppLightbox() method opens a lightbox by its ID and optionally passes data to it. Use this in your app's site widget to trigger the app's lightbox. Learn more about site lightbox extensions.
To access the data passed to a lightbox, call getContext() in the lightbox's code.
If the lightbox is closed programmatically using close()
and includes data, the promise returned by openAppLightbox() resolves with that data.
Learn more about opening and closing a lightbox from your app's code
function openAppLightbox(id: string, data: object): Promise<object>;The ID of the lightbox, as defined in the app dashboard.
Data to pass to the lightbox.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.