wix-cli-dashboard-menu-plugin

Wix Dashboard Menu Plugin Builder

Creates dashboard menu plugin extensions for Wix CLI applications. Dashboard menu plugins are menu items that integrate into predefined menu slots on dashboard pages managed by Wix first-party business apps (Wix Stores, Wix Bookings, Wix Blog, Wix eCommerce, Wix Events, Wix CRM, Wix Restaurants).

When clicked, a dashboard menu plugin either navigates to a dashboard page or opens a dashboard modal.

Dashboard menu plugins are configuration-only extensions — they do NOT have a React component file.

---

Quick Start Checklist

Follow these steps in order when creating a dashboard menu plugin:

1. Identify the target menu slot ID — see Slot Lookup Table below, then read only the relevant vertical file
2. Create plugin folder: src/extensions/dashboard/menu-plugins/<plugin-name>/
3. Create <plugin-name>.extension.ts with extensions.dashboardMenuPlugin() and unique UUID
4. Configure the action field to either navigate to a dashboard page or open a modal
5. Update src/extensions.ts to import and use the new extension

Architecture

Dashboard menu plugins operate as click-to-action menu items. They:

1. Appear as labeled items with an icon in a menu slot on a Wix app's dashboard page
2. When clicked, perform one of two actions:
   • Navigate to a dashboard page — redirects to a specified dashboard page
   • Open a dashboard modal — displays a specified dashboard modal

Files and Code Structure

Dashboard menu plugins live under src/extensions/dashboard/menu-plugins/. Each plugin has its own folder containing a single file.

src/extensions/dashboard/menu-plugins/
└── <plugin-name>/
    └── <plugin-name>.extension.ts   # Builder configuration

Note: This is the default folder structure created by the CLI. You can move the file to any location within the src/ folder and update the references in your extension.ts file.

Plugin Builder Configuration

File: <plugin-name>.extension.ts

import { extensions } from "@wix/astro/builders";

export const dashboardmenupluginMyMenuPlugin = extensions.dashboardMenuPlugin({
  id: "{{GENERATE_UUID}}",
  title: "My Menu Plugin",
  extends: "<MENU_SLOT_ID>",
  iconKey: "Sparkles",
  action: {
    navigateToPage: {
      pageId: "<DASHBOARD_PAGE_ID>",
    },
  },
});

CRITICAL: UUID Generation

The id must be a unique, static UUID v4 string. Generate a fresh UUID for each extension — do NOT use randomUUID() or copy UUIDs from examples. Replace {{GENERATE_UUID}} with a freshly generated UUID like "a1b2c3d4-e5f6-7890-abcd-ef1234567890".

Builder Fields

Field	Type	Description
id	string	Unique plugin ID (GUID). Must be unique across all extensions in the project.
title	string	Text displayed for the menu item.
extends	string	Menu slot ID where the extension integrates. See Slot Lookup Table.
iconKey	string	Icon name from Wix Design System appearing next to the title.
action	object	Navigation configuration determining behavior when clicked.

The extends Field

The extends field specifies which dashboard menu slot hosts your menu plugin. Each Wix business app exposes menu slots on its dashboard pages. You must provide the exact slot ID.

Important: Some slots with the same ID appear on different pages within the dashboard. If you create a menu plugin for a slot that exists on multiple pages, the menu plugin is displayed on all of those pages.

For the complete list of available menu slot IDs, see the Slot Lookup Table below. Read only the vertical file that matches the user's request.

The action Field

The action field determines what happens when the user clicks the menu item. You must configure exactly one of the following:

Option 1: Navigate to a Dashboard Page

action: {
  navigateToPage: {
    pageId: "<DASHBOARD_PAGE_ID>",
  },
},

Field	Type	Description
action.navigateToPage	object	Page navigation configuration object.
action.navigateToPage.pageId	string	The id of the target dashboard page extension.

Option 2: Open a Dashboard Modal

action: {
  openModal: {
    componentId: "<DASHBOARD_MODAL_ID>",
  },
},

Field	Type	Description
action.openModal	object	Modal navigation configuration object.
action.openModal.componentId	string	The id of the target dashboard modal extension.

The iconKey Field

The iconKey must be a valid icon name from the Wix Design System icon set (@wix/wix-ui-icons-common). Use the wds-docs skill to look up available icon names.

Extension Registration

Extension registration is MANDATORY and has TWO required steps.

Step 1: Create Plugin-Specific Extension File

Each dashboard menu plugin requires a <plugin-name>.extension.ts file in its folder. See Plugin Builder Configuration above.

Step 2: Register in Main Extensions File

CRITICAL: After creating the plugin-specific extension file, you MUST read wix-cli-extension-registration and follow the "App Registration" section to update src/extensions.ts.

Without completing Step 2, the dashboard menu plugin will not appear on the dashboard page.

Hard Constraints

• Do NOT invent or assume new types, modules, functions, props, events, or imports — use only entities explicitly present in the provided references or standard libraries already used in this project
• NEVER use mocks, placeholders, or TODOs in any code — ALWAYS implement complete, production-ready functionality
• The extends field MUST contain a valid menu slot ID from a Wix business app — do NOT invent slot IDs
• The action.navigateToPage.pageId MUST reference the id of an existing dashboard page extension in the project
• The action.openModal.componentId MUST reference the id of an existing dashboard modal extension in the project
• A dashboard menu plugin does NOT have a React component — it is configuration-only
• Do NOT confuse dashboard menu plugins with dashboard plugins — they are different extension types

Slot Lookup Table

Identify which Wix app the user is targeting, then read only the corresponding reference file for slot IDs.

Wix App	Keywords	Slot Reference
Wix Blog	blog, posts, categories, tags, drafts, scheduled	blog-slots.md
Wix Bookings	bookings, calendar, services, staff, booking list	bookings-slots.md
Wix CRM	CRM, contacts	crm-slots.md
Wix eCommerce	ecommerce, orders, payment	ecommerce-slots.md
Wix Events	events, guests, RSVP, ticketed	events-slots.md
Wix Stores	stores, products, inventory, catalog	stores-slots.md
Wix Restaurants	restaurants, reservations, online orders, menus	restaurants-slots.md

Output Constraints

Token limits: Your max output is ~10,000 tokens. Plan your response to stay under this limit.

• Only output files that are directly required for the task
• Do NOT add README.md or documentation files unless explicitly requested