Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

The ID of the page on which the widget is added, as defined in the Installation Settings.

pageId

string

Gets the URL of the new page that was added by a Blocks app, when installed on a site.

The `getAppPageUrl()` function returns a Promise that resolves to a string with a URL of the new page that was added by a Blocks app, when a widget is installed on a site as a new page. 
Learn more about [app and widget installation settings](https://support.wix.com/en/article/wix-blocks-app-and-widget-installation-settings).

import wixApplication from 'wix-application';
import wixLocation from 'wix-location';

//...

wixApplication.getAppPageUrl('Page ID')
    .then((url) => {
        if (url) {
            wixLocation.to(url);
        } else {
            console.log("Page doesn't exist");
            return;
        }
    })
    .catch((error) => {
        console.error(error);
        // Handle the error
    });

Retrieve the new page's URL and go to that page

getAppPageUrl

Gets the Wix Blocks App data as a decoded Json Web Token (JWT) object.

The `getDecodedAppInstance()` function returns a Promise that resolves to an object with data about the installation of your app on a specific site. 
It is useful when [managing your application's pricing](https://support.wix.com/en/article/wix-blocks-setting-up-and-managing-your-apps-pricing).

import wixApplication from 'wix-application';

// ...

wixApplication.getDecodedAppInstance()
  .then((instance) => {
    const plan = instance.vendorProductId;  // 'basic'
  })
  .catch((error) => {
    console.error(error);
    // Handle the error
  });

Retrieve the Vendor Product ID

getDecodedAppInstance

decodedAppInstance

Fulfilled - An object with data about the installation of your app on a specific site.

The ID of the lightbox, as defined in the installation settings.

lightboxId

data

object

Opens a lightbox that was added to a site by the Blocks app, during the app installation process and optionally passes it data.

The `openAppLightbox()` function returns a Promise that resolves to an object with data from the lightbox, when the lightbox is closed. Use it when a widget is installed as a lightbox.  
Learn more about [app and widget installation settings](https://support.wix.com/en/article/wix-blocks-app-and-widget-installation-settings).   

Note that to pass data back to the page that opened the lightbox, you must close the
 lightbox programmatically using the `close()` function. If the lightbox is
 closed by the site visitor clicking the 'X' icon, close button, or lightbox
 overlay, data will not be passed back the the page that opened the lightbox.
 Therefore, if you want to make sure data is passed back to the page that
 opened the lightbox, [disable all of the methods mentioned above](https://support.wix.com/en/article/wix-editor-adding-and-setting-up-a-lightbox#step-4-choose-how-visitors-close-the-lightbox) and create your own method for closing
 the lightbox programmatically. For example, you can add a button with an `onClick` event
 handler that calls the `close()` function.

import wixApplication from 'wix-application';

// ...

wixApplication.openAppLightbox("lightboxId");

Open a lightbox

import wixApplication from 'wix-application';

// ...

const dataObj = {title: "Widget Title"};
wixApplication.openAppLightbox("lightboxId", dataObj);

Open a lightbox and send it data

import wixApplication from 'wix-application';

// ...

wixApplication.openAppLightbox("lightboxId")
  .then( (data) => { 
    let receivedData = data; // When the lightbox is closed, it returns this data
  } );

Open a lightbox and receive data when it closes

import wixApplication from 'wix-application';

// ...

const dataObj = {title: "My Title"};
wixApplication.openAppLightbox("ligthboxId", dataObj)
  .then( (data) => {
    let receivedData = data;  // When the lightbox is closed, it returns this data. 
  } );

Open a lightbox, send it data and receive data back when it closes

openAppLightbox

Fulfilled - The returned data from the lightbox.

# Introduction
> **This module is available only in Wix Blocks**  
> [Wix Blocks](https://dev.wix.com/docs/build-apps/wix-blocks/getting-started/welcome-to-wix-blocks) is an editor for building Wix apps. To get access to Blocks, join [Wix Studio](https://support.wix.com/en/article/wix-studio-switching-to-wix-studio).

To use the wixApplication API, import `wixApplication` from the `wix-application` module:

```javascript
import wixApplication from 'wix-application';
```

getAppPageUrl( )