About the Dashboard Favorite List API

The Dashboard Favorite List API provides functionality to create and manage a list of favorite dashboard pages. It allows you to streamline Wix users to dashboard navigation experience and make important pages quickly accessible.

The Dashboard Favorite List API provides functionality to create and manage a list of favorite dashboard pages. It allows you to streamline Wix users' dashboard navigation experience and make important pages quickly accessible.

With the Dashboard Favorite List API, users can:

• Create, retrieve, update, and delete their list of dashboard favorites.
• Add and delete individual dashboard favorites to and from their list.
• Create nested views of collections, developer tools, or other dashboard pages for quick access.
• Assign custom titles to favorite pages for easier navigation.

Before you begin

It's important to note the following points before starting to code:

• Each Wix user can only have one list of favorite dashboard pages.

• We recommend you avoid making changes to the list without the user taking explicit action.

• To use the Dashboard Favorite List API, import favoriteList from the wix-dashboard-management.v2 module:

  Copy

Use cases

• Including an Add to Favorites button in your dashboard pages to streamline your contributors' dashboard navigation experience.
• Create a nested view of frequently visited dashboard pages for quick access.

Terminology

• Dashboard Favorite List: A UI element that displays a list of favorite dashboard pages used for quick access.
• Dashboard Favorite Page: A dashboard favorite page on the list. It has a custom title, and it can have a relative URL.
• Page: A dashboard page.