Switch to a page

webflow.switchPage(page)

Switch the Designer to a specified page.

Syntax

1
webflow.switchPage(page: Page): Promise<null>

Parameters

page : Page - The page to switch to.

Returns

Promise<null>

A Promise that resolves to null when the page switch is complete.

Example

1
// Get All Pages and Folders
2
const pagesAndFolders = await webflow.getAllPagesAndFolders()
3
const pages = pagesAndFolders?.filter((i): i is Page => i.type === "Page")
4
5
// Switch Page
6
const newPage = pages[2]
7
await webflow.switchPage(newPage)

Switching to a branch page

Branch pages are regular pages internally, so you can pass a branch page to switchPage() to navigate to a branch. Use page.listBranches() to discover available branches and page.getParentPageId() to navigate back to the main page.

Designer Ability

Checks for authorization only