Migrating from dashboard-react

As of September 2024, the Wix dashboard-react SDK is deprecated and closed to new users. You can access the functionality of the dashboard-react SDK using the Dashboard SDK.

Below is a list of the deprecated dashboard-react components and functions and their alternatives in the Dashboard SDK.

Important:

If you are building a self hosted app, you must create a Wix Client to use the Dashboard SDK.

Instead of navigating in the dashboard using PageLink, use navigate() from the Dashboard SDK.

withDashboard()

There is no use case for withDashboard() because it is used to initialize the React SDK and the Dashboard React SDK, both of which are deprecated.

Note: This hook is temporarily required for use in Wix Patterns. It will continue to be supported while it is required.

useDashboard()

Instead of accessing dashboard functions through useDashboard(), call them directly.

Wix-hosted example
Copy
1
Self-hosted example
Copy
1

usePageLocation()

Instead of calling usePageLocation(), access PageLocation properties using the EnvironmentState property in observeState().

Was this helpful?
Yes
No