About Site Window

The Site Window API provides information about a site visitor's browsing environment and tools to interact with the browser window.

With the Site Window API you can:

Detect locale and device type
Get page and router data
Open modals and lightboxes
Manage clipboard content
Scroll the page with code

Note: The terms popup and lightbox refer to the same element. While the editor and dashboard now refer to it as a popup, the API methods continue to use the term lightbox for backward compatibility. The documentation uses both terms accordingly.

Terminology

Browser locale: The locale (language and regional format) of the visitor's browser, represented by an IETF language tag (for example, en-US).
Referrer: The URL of the web page the site visitor was on before arriving at the current page.

Did this help?