The Page API provides information about the dashboard page that renders your extension. Use it to read the layout the dashboard chose for your extension so your app can adapt its UI.
The Page API is a separate top-level module in the @wix/dashboard package. Import it directly. It isn't available as dashboard.page.
Note: The Page API only works in the code of dashboard extensions, so it isn't available when developing sites or building apps with Blocks.
The page API is part of the @wix/dashboard package. If you already use the Dashboard API, you've already installed the package.
Follow the installation instructions for your development environment.
| Development environment | Installation method |
|---|---|
| CLI and self-hosted apps | Run npm install @wix/dashboard or yarn add @wix/dashboard. |
| Wix-managed headless | Run npm install @wix/dashboard or yarn add @wix/dashboard. |
Import the page module in your code and call its methods directly:
To use the page API in self-hosted apps, set up a client as described in the Dashboard API introduction, and include page in the client's modules.