Side panels are panels that slide in alongside a dashboard page. Use the Side Panel API to open a side panel that renders one of your app's embeddable components, and to close it from the component's code.
The Side Panel API is a separate top-level module in the @wix/dashboard package. Import it directly. It isn't available as dashboard.sidePanel.
Note: Side panels work only in the code of dashboard extensions, so they don't work when developing sites or building apps with Blocks.
The Side Panel 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-managed 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 sidePanel module in your code and call its methods directly:
To use the sidePanel API in self-managed apps, set up a client as described in the Dashboard API introduction, and include sidePanel in the client's modules.