subscribe("currentpage", callback)

Use this method to start listening for specific events in your App. In this case, we're listening for when a user selects a new page in the Designer.

Syntax

 webflow.subscribe( event: 'currentpage',callback: (element: null | AnyElement) => void): Unsubscribe;

Parameters

event : "currentpage"

The name of the event to subscribe to.

callback: (page: Page => void)

The callback function to execute when the event occurs. The page parameter should be the page you're watching.

Returns

Unsubscribe

This is a special function you receive after subscribing. When you no longer want to listen to the event, call this function to stop receiving notifications.

Example

// Subscribe to changes in the selected page
const selectedPageCallback = (page: Page | null) => {
  if (page) {
    console.log('Selected Page:', page);
  } else {
    console.log('No element is currently selected.');
  }
}

const unsubscribeSelectedElement = webflow.subscribe('currentpage', selectedPageCallback);