wix-cli-dashboard-page（WIX CLI dashboard page 搜索）

Wix Dashboard Page Builder

Creates full-featured dashboard page extensions for Wix CLI applications. Dashboard pages appear in the Wix site owner's dashboard and enable site administrators to manage data, configure settings, and perform administrative tasks.

Quick Start Checklist

Follow these steps in order when creating a dashboard page:

1. [ ] Create page folder: src/dashboard/pages/<page-name>/
2. [ ] Create page.tsx with WDS components wrapped in WixDesignSystemProvider
3. [ ] Create extensions.ts with extensions.dashboardPage() and unique UUID
4. [ ] Update src/extensions.ts to import and use the new extension
5. [ ] Run npx tsc --noEmit to verify TypeScript compiles
6. [ ] Run npx wix build to verify build succeeds
7. [ ] Run npx wix preview and navigate to the page route

Non-Matching Intents

Do NOT use this skill for:

• Site pages (visitor-facing) → Use wix-site-page
• Embedded widgets (custom elements) → Use wix-cli-embedded-script
• Backend APIs (HTTP functions) → Use wix-cli-backend-api
• Service plugins (checkout, shipping SPIs) → Use wix-cli-service-plugin
• Modals/Dialogs (popup forms, confirmations, detail views) → Use wix-cli-dashboard-modal for dashboard modals

Capabilities

UI Components (Wix Design System)

Layout: Page, Page.Content, Layout, Cell, Card, Box

Data Display: Table, TableToolbar, Text, Heading, Badge, EmptyState

Forms: FormField, Input, Dropdown, Checkbox, ToggleSwitch, DatePicker, RichTextInputArea

Actions: Button, Toast notifications

See more in "Supported WDS Components" section.

Data Operations (Wix Data SDK)

See Wix Data Reference for complete documentation.

Summary:

• Read: items.query('Collection').filter/sort.limit.find() → { items, totalCount, hasNext }
• Write: items.insert | update | remove. Ensure collection permissions allow the action

Query methods: eq, ne, gt, ge, lt, le, between, contains, startsWith, endsWith, hasSome, hasAll, isEmpty, isNotEmpty, and, or, not, ascending, descending, limit, skip, include

Dashboard APIs

See Dashboard API Reference for complete documentation including all methods, page IDs, and examples.

Key methods:

• dashboard.navigate() - Navigate between dashboard pages
• dashboard.observeState() - Receive contextual state and environmental information
• dashboard.showToast() - Display toast notifications
• dashboard.openModal() - Open dashboard modal extensions (see wix-cli-dashboard-modal)
• dashboard.navigateBack() - Navigate back to previous page
• dashboard.getPageUrl() - Get full URL for a dashboard page
• dashboard.openMediaManager() - Open Wix Media Manager
• dashboard.onBeforeUnload() - Register beforeunload handler
• dashboard.addSitePlugin() - Add site plugin to slots
• dashboard.setPageTitle() - Set page title in browser tab
• dashboard.onLayerStateChange() - Handle foreground/background state changes

CRITICAL: Using Modals in Dashboard Pages

When you need to display popup forms, confirmations, detail views, or any dialog overlays from a dashboard page, you MUST use dashboard modals, not regular React modals or WDS Modal components.

• Use dashboard modals for: edit forms, delete confirmations, detail views, settings dialogs, any popup content
• Do NOT use WDS Modal component or custom React modal implementations
• See wix-cli-dashboard-modal for complete implementation guide

Dashboard modals are opened using dashboard.openModal() and provide proper integration with the dashboard lifecycle, state management, and navigation.

Ecom Navigation: See Ecom Navigation Reference for ecom-specific navigation helpers.

Embedded Script Configuration API

When building a dashboard page to configure an embedded script, see Dynamic Parameters Reference for complete implementation guide.

Key points:

• Use embeddedScripts from @wix/app-management
• Parameters are returned as strings - handle type conversions when loading
• All parameters must be saved as strings (convert booleans/numbers to strings)
• Use withProviders wrapper when dynamic parameters are present

Files and Code Structure

Dashboard pages live under src/dashboard/pages. Each page has its own folder.

File structure:

• src/dashboard/pages/<page>/page.tsx — page component

Key metadata fields:

• id (string, GUID): Unique page ID used to register the page
• title (string): Used for browser tab and optional sidebar label
• additionalRoutes (string[], optional): Extra routes leading to this page
• sidebar.disabled (boolean, optional): Hide page from sidebar (default false)
• sidebar.priority (number, optional): Sidebar ordering; lower is higher priority
• sidebar.whenActive.selectedPageId (string, optional): Which page appears selected when this page is active
• sidebar.whenActive.hideSidebar (boolean, optional): Hide sidebar when this page is active

WDS Provider Usage

Wrap your dashboard page component with WixDesignSystemProvider to enable WDS components and theming.

import { WixDesignSystemProvider } from "@wix/design-system";
export default function () {
  return (
    <WixDesignSystemProvider>
      <Page>
        <Page.Header
          title="My Page"
          subtitle="This is a subtitle for your page"
        />
        <Page.Content>
          <EmptyState title="My Page" subtitle="Hello World!" theme="page" />
        </Page.Content>
      </Page>
    </WixDesignSystemProvider>
  );
}

Note: When using dynamic parameters, use the withProviders wrapper instead. See Dynamic Parameters for details.

Supported WDS Components

Use ONLY these Wix Design System components. Do NOT use components from @wix/wix-ui-icons-common unless you know the correct import path and it's explicitly needed for icons.

Supported components: AutoComplete, Badge, Box, Button, IconButton, TextButton, Card, Card.Content, Card.Divider, Card.Header, Card.Subheader, Cell, Checkbox, ColorInput, CornerRadiusInput, Divider, Dropdown, EmptyState, FormField, Heading, IconButton, Input, InputArea, Layout, Loader, MarketingLayout, NestableList, NumberInput, Page, Page.Footer, Page.Header, Page.Section, RichTextInputArea, SectionHeader, SidePanel, Table, TableActionCell, TableListHeader, TableListItem, TableToolbar, TagList, Text, TextButton, TimeInput, Tooltip, ToggleSwitch

For detailed component information, see WDS Components Reference.

Querying Component Details

When you need detailed information about specific WDS components (descriptions, usage guidelines, feature examples, code snippets), use the shared query script:

# From the wix-cli-dashboard-page directory:
node ../scripts/query-wds-components.js <component-name> [<component-name> ...]

# Examples:
node ../scripts/query-wds-components.js Button Card
node ../scripts/query-wds-components.js Page Page.Header Page.Content
node ../scripts/query-wds-components.js Table TableToolbar

The script reads from ../assets/wds-storybook.json and outputs formatted component information including do's and don'ts, feature examples, and usage guidelines. This is especially useful when you need:

• Specific prop usage examples
• Best practices for component usage
• Feature-specific code examples
• Detailed component descriptions

See WDS Components Reference for more information about the query script and JSON structure.

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.
• If something is missing, call it out explicitly and provide a minimal TODO or clearly marked placeholder rather than creating it.
• Use ONLY WDS components that are explicitly listed in the supported components list above.
• Do NOT use components from @wix/wix-ui-icons-common unless you know the correct import path and it's explicitly needed for icons
• Always verify component availability before using it in your generated code
• If you need a component not in the list, use a basic HTML element or create a simple custom component instead
• Do NOT use WDS Modal component or custom React modal implementations - Always use dashboard modals (see wix-cli-dashboard-modal) for any popup dialogs, forms, or overlays

Examples

Data Management Table

Request: "Create a dashboard page to manage blog posts"

Output: Page with table displaying posts, search toolbar, add/edit/delete actions, empty state.

Settings Form

Request: "Build a settings page for notification preferences"

Output: Page with form fields, save button with toast confirmation, unsaved changes warning.

Order Management

Request: "Create an admin panel for customer orders"

Output: Page with orders table, status badges, filters, detail dashboard modal (using wix-cli-dashboard-modal), status update actions.

Embedded Script Configuration

Request: "Create a settings page for the coupon popup embedded script"

Output: Page with form fields for popup headline, coupon code, minimum cart value, and enable toggle. Uses embeddedScripts API to load/save parameters.

// Key pattern for embedded script configuration pages
import { embeddedScripts } from "@wix/app-management";

// Load on mount
useEffect(() => {
  const load = async () => {
    const script = await embeddedScripts.getEmbeddedScript();
    const data = script.parameters || {};
    setOptions({
      headline: data.headline || "Default",
      enabled: data.enabled === "true",
      threshold: Number(data.threshold) || 0,
    });
  };
  load();
}, []);

// Save handler
const handleSave = async () => {
  await embeddedScripts.embedScript({
    parameters: {
      headline: options.headline,
      enabled: String(options.enabled),
      threshold: String(options.threshold),
    },
  });
  dashboard.showToast({ message: "Saved!", type: "success" });
};

Extension Registration

Extension registration is MANDATORY and has TWO required steps.

Step 1: Create Page-Specific Extension File

Each dashboard page requires an extensions.ts file in its folder:

File: src/dashboard/pages/<page-name>/extensions.ts

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

export const dashboardpageMyPage = extensions.dashboardPage({
  id: "{{GENERATE_UUID}}",
  title: "My Page",
  routePath: "my-page",
  component: "./dashboard/pages/my-page/page.tsx",
});

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".

Step 2: Register in Main Extensions File

CRITICAL: After creating the page-specific extension file, you MUST read ../../skills/references/EXTENSIONS.md and follow the "App Registration" section to update src/extensions.ts.

Without completing Step 2, the dashboard page will not appear in the Wix dashboard.

Common Mistakes - Do NOT

API confusion with other extension types:

Do NOT copy field names from embedded script or other extension registrations. Dashboard pages use title, routePath, and component.

Code Quality Requirements

TypeScript Quality Guidelines

• Generated code MUST compile with zero TypeScript errors under strict settings: strict, noImplicitAny, strictNullChecks, exactOptionalPropertyTypes, noUncheckedIndexedAccess
• Prefer type-narrowing and exhaustive logic over assertions; avoid non-null assertions (!) and unsafe casts (as any)
• Treat optional values, refs, and array indexing results as possibly undefined and handle them explicitly
• Use exhaustive checks for unions (e.g., switch with a never check) and return total values (no implicit undefined)
• Do NOT use // @ts-ignore or // @ts-expect-error; fix the types or add guards instead

Core Principles

• Do NOT invent or assume new types, modules, functions, props, events, or imports
• NEVER use mocks, placeholders, or TODOs in any code
• ALWAYS implement complete, production-ready functionality
• Follow Wix dashboard page patterns and best practices precisely
• Handle all edge cases and error scenarios appropriately

Code Quality Standards

• Prefer TypeScript with appropriate typing
• Use consistent naming conventions
• Include error handling where appropriate
• Add documentation for complex or non-obvious logic
• Prefer async/await for asynchronous operations
• Consider destructuring for cleaner code when beneficial
• Return well-structured response objects

Error Handling

• Always implement proper error handling in dashboard pages
• Return appropriate error responses when data is invalid
• Log errors appropriately for debugging using console.error
• Handle network timeouts and external service failures

Output Constraints

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

• If making a large file (>300 lines), split it into multiple smaller files with imports.
• If editing a large section (>100 lines), break it into multiple smaller edit operations.
• Count your output before responding - if it seems too long, reduce scope and prioritize.

Brevity rules: Minimize output tokens while maintaining quality and correctness.

• Do NOT add README.md, documentation files, or markdown files unless explicitly requested.
• Do NOT add excessive comments in code - only add comments where truly necessary for clarity.
• Do NOT re-output unchanged files or duplicate existing code.
• Do NOT generate placeholder code like "// TODO: implement" - provide working implementations.
• Only output files that are directly required for the task.

Modular code strategy: When generating substantial code, split into multiple smaller files with imports:

• Extract utilities/helpers into separate files
• Separate types/interfaces into dedicated type files
• Keep each component/function focused (~50-100 lines max)

Verification

After implementation, use wix-cli-app-validation to validate TypeScript compilation, build, preview, and runtime behavior.

API Spec Support

When an API specification is provided, you can make API calls to those endpoints. See API Spec Reference for details on how to use API specs in dashboard pages.