Introduction
To use the window module, import wixWindowFrontend from the wix-window-frontend module:
The APIs in wix-window-frontend can only be used in frontend code.
Learn more about wix-window-frontend in Getting Started and on Wix Learn.
App Page Data
You can use the getAppPageData() method for custom app pages to retrieve data you can use to customize the page. The data passed to each type of custom app page is different. This article lists the objects passed to each type of custom app page.
Booking Service Page
The object passed to a custom Booking Service page contains the following properties:
| Name | Type | Description |
|---|---|---|
service | Object | The Service object, which contains detailed data about the service. |
Note: If the page URL specifies a service that is deleted, hidden, or does not exist, the app returns null.
Learn more about building a custom Service page.
Booking Calendar Page
The object passed to a custom Booking Calendar page contains the following properties:
| Name | Type | Description |
|---|---|---|
service | Object | The Service object, which contains detailed data about the service. |
Pricing Plans Page
The object passed to a custom Pricing Plans page contains the following properties:
| Name | Type | Description |
|---|---|---|
plan | Object | The Plan object, which contains detailed data about the plans. |
Note: If the page URL specifies a plan that is deleted, hidden, or does not exist, the app returns null.
Learn more about building a custom Pricing Plans page.
browserLocale
Gets the locale of a site visitor's browser.
A locale, also known as an IETF language tag, is an abbreviated code that defines the language, country, and other aspects of a site visitor's browser, such as number format and date format.
Some common locales include:
"en-US": English, United States"en-GB": English, British"es-ES": Spanish, Spain"de-DE": German, Germany"ja-JP": Japanese, Japan"fr-CH": French, Switzerland"it-IT": Italian, Italy
formFactor
Gets what kind of device is being used to view a page.
Note: This property only checks a site visitor's device, and not which Studio Editor's breakpoint they are using.
The formFactor property gets one of:
"Desktop": When viewed in a desktop browser."Mobile": When viewed in a mobile browser."Tablet": When viewed in a tablet browser.
Important: Some tablet devices (such as iPads) are identified in this property as "Desktop".
referrer
Gets the HTTP referrer header field.
The referrer is the address of the web page a site visitor was previously
on before arriving at the current page, typically by clicking a link.
Note: When site visitors move from page to page within your site, the referrer property
does not contain the address of the page the site visitor came from. This is because
Wix sites are built as single page applications.
To get the previous page a site visitor was visiting within your site, you can
use wix-storage-frontend to store the visitor's current page
and retrieve the visitor's previous page.
viewMode
Gets which mode a site is currently being viewed in.
The viewMode property gets either:
"Preview": When previewing a site using the Preview button in the editor."Site": When viewing a published site."Editor": When viewing a Wix Blocks built widget in the editor.
copyToClipboard( )
Copies text to a site visitor's clipboard.
The copyToClipboard() method copies the specified text to a site visitor's clipboard.
If a site visitor's browser doesn't support copying text to the clipboard
programmatically, a modal popup that allows copying will be displayed.
For example, when calling copyToClipboard() from a Firefox or Edge browser,
a site visitor will see something similar to the popup shown below.
The Promise returned by copyToClipboard() resolves when the
specified text is copied to clipboard or the modal popup is closed.
The Promise is rejected if a null value is passed as the toCopy parameter
or if a site visitor's browser blocks the modal popup from opening.
The text to copy.
getAppPageData( )
Gets the data passed to a custom app page.
Wix passes data to custom app pages that you can use when implementing a page's business logic.
Call the getAppPageData() method to retrieve the data and use it in your code.
The data retrieved by this method is different for each type of custom app page.
For more information, see App Page Data.
Learn more about building custom app pages.
Note: If you call getAppPageData() for a page that isn't
a custom app page, it returns null.
getBoundingRect( )
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.
getCurrentGeolocation( )
Gets the current geolocation of a site visitor.
The getCurrentGeolocation() method has the following limitations:
- On Chrome, the function only works on HTTPS sites.
- On Chrome, Firefox, and Safari, the function only works if the site visitor approves a popup. If they do not approve, the promise is rejected.
- Run
getCurrentGeolocation()with asetTimeout()in case the browser is set to not detect the locale. Adding the timeout lets you handle the unfulfilled promise.
getRouterData( )
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(): object;import wixWindowFrontend from "wix-window-frontend";
// ...
let routerData = wixWindowFrontend.getRouterData();