wix-cli-dashboard-menu-plugin

Wix Dashboard Menu Plugin Builder

Wix CLI アプリケーション用のダッシュボードメニュープラグイン拡張機能を作成します。ダッシュボードメニュープラグインは、Wix のファーストパーティビジネスアプリ（Wix Stores、Wix Bookings、Wix Blog、Wix eCommerce、Wix Events、Wix CRM、Wix Restaurants）が管理するダッシュボードページ上の、あらかじめ定義されたメニュースロットに統合されるメニュー項目です。

クリックすると、ダッシュボードメニュープラグインはダッシュボードページに移動するか、ダッシュボードモーダルを開きます。

ダッシュボードメニュープラグインは設定のみの拡張機能であり、React コンポーネントファイルはありません。

---

クイックスタートチェックリスト

ダッシュボードメニュープラグインを作成するときは、以下の手順を順番に実行してください。

1. 対象のメニュースロット ID を特定します。下記のスロット検索テーブルを参照し、該当する垂直分野のファイルのみを読みます
2. プラグインフォルダーを作成します：src/extensions/dashboard/menu-plugins/<plugin-name>/
3. extensions.dashboardMenuPlugin() と一意の UUID を使って <plugin-name>.extension.ts を作成します
4. action フィールドを設定して、ダッシュボードページへの移動またはモーダルを開く操作を指定します
5. src/extensions.ts を更新して、新しい拡張機能をインポートして使用します

アーキテクチャ

ダッシュボードメニュープラグインは、クリックしてアクションを実行するメニュー項目として機能します。具体的には、次のとおりです。

1. Wix アプリのダッシュボードページにあるメニュースロットに、ラベルとアイコン付きで表示されます
2. クリックすると、次のいずれかの操作を実行します。
   • ダッシュボードページに移動 — 指定されたダッシュボードページに移動します
   • ダッシュボードモーダルを開く — 指定されたダッシュボードモーダルを表示します

ファイルとコードの構成

ダッシュボードメニュープラグインは src/extensions/dashboard/menu-plugins/ の下に配置します。各プラグインには、1 つのファイルを含む専用フォルダーがあります。

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

注： これは CLI によって作成されるデフォルトのフォルダー構造です。ファイルは src/ フォルダー内の任意の場所に移動でき、extension.ts ファイル内の参照を更新できます。

プラグインビルダーの設定

ファイル：<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>",
    },
  },
});

重要：UUID の生成

id は一意で固定の UUID v4 文字列である必要があります。拡張機能ごとに新しい UUID を生成してください。randomUUID() を使用したり、例の UUID をコピーしたりしないでください。{{GENERATE_UUID}} を "a1b2c3d4-e5f6-7890-abcd-ef1234567890" のように新しく生成した UUID に置き換えてください。

ビルダーのフィールド

フィールド	型	説明
id	string	一意のプラグイン ID（GUID）です。プロジェクト内のすべての拡張機能で一意である必要があります。
title	string	メニュー項目に表示されるテキストです。
extends	string	拡張機能が統合されるメニュースロット ID です。スロット検索テーブルを参照してください。
iconKey	string	タイトルの横に表示される Wix Design System のアイコン名です。
action	object	クリック時の動作を決定するナビゲーション設定です。

extends フィールド

extends フィールドでは、メニュープラグインを配置するダッシュボードのメニュースロットを指定します。各 Wix ビジネスアプリは、ダッシュボードページにメニュースロットを公開します。正確なスロット ID を指定する必要があります。

重要： 同じ ID のスロットが、ダッシュボード内の異なるページに存在する場合があります。複数のページに存在するスロット用にメニュープラグインを作成すると、そのメニュープラグインはそれらすべてのページに表示されます。

利用可能なメニュースロット ID の一覧については、下記のスロット検索テーブルを参照してください。ユーザーのリクエストに該当する垂直分野のファイルのみを読んでください。

action フィールド

action フィールドでは、ユーザーがメニュー項目をクリックしたときの動作を指定します。次のいずれか 1 つだけを設定してください。

オプション 1：ダッシュボードページに移動する

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

フィールド	型	説明
action.navigateToPage	object	ページ移動の設定オブジェクトです。
action.navigateToPage.pageId	string	対象となるダッシュボードページ拡張機能の id です。

オプション 2：ダッシュボードモーダルを開く

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

フィールド	型	説明
action.openModal	オブジェクト	モーダルナビゲーションの設定オブジェクトです。
action.openModal.componentId	文字列	対象となるダッシュボードモーダル拡張機能の id です。

iconKey フィールド

iconKey には、Wix Design System のアイコンセット（@wix/wix-ui-icons-common）に含まれる有効なアイコン名を指定する必要があります。利用可能なアイコン名は wds-docs スキルで確認してください。

拡張機能の登録

拡張機能の登録は必須であり、2 つの手順が必要です。

手順 1：プラグイン固有の拡張機能ファイルを作成する

各ダッシュボードメニュープラグインには、フォルダー内に <plugin-name>.extension.ts ファイルが必要です。上記のプラグインビルダーの設定を参照してください。

手順 2：メインの拡張機能ファイルに登録する

重要： プラグイン固有の拡張機能ファイルを作成した後、wix-cli-extension-registration を必ず読み、「App Registration」セクションに従って src/extensions.ts を更新してください。

手順 2 を完了しないと、ダッシュボードメニュープラグインはダッシュボードページに表示されません。

厳守事項

• 新しい型、モジュール、関数、プロパティ、イベント、インポートを創作したり、あると仮定したりしないでください。提供されたリファレンスまたはこのプロジェクトですでに使用されている標準ライブラリに明示されているものだけを使用してください。
• コード内でモック、プレースホルダー、TODO を使用しないでください。必ず、本番環境で使える完全な機能を実装してください。
• extends フィールドには、Wix ビジネスアプリの有効なメニュースロット ID を指定する必要があります。スロット ID を創作しないでください。
• action.navigateToPage.pageId は、プロジェクト内に既存のダッシュボードページ拡張機能の id を参照する必要があります。
• action.openModal.componentId は、プロジェクト内に既存のダッシュボードモーダル拡張機能の id を参照する必要があります。
• ダッシュボードメニュープラグインには React コンポーネントがありません。設定のみで構成されます。
• ダッシュボードメニュープラグインとダッシュボードプラグインを混同しないでください。これらは異なる拡張機能の種類です。

スロット検索表

ユーザーが対象としている Wix アプリを特定し、スロット ID については対応するリファレンスファイルのみを読んでください。

Wix アプリ	キーワード	スロットのリファレンス
Wix Blog	ブログ、投稿、カテゴリー、タグ、下書き、予約済み	blog-slots.md
Wix Bookings	予約、カレンダー、サービス、スタッフ、予約リスト	bookings-slots.md
Wix CRM	CRM、連絡先	crm-slots.md
Wix eCommerce	eコマース、注文、決済	ecommerce-slots.md
Wix Events	イベント、ゲスト、RSVP、チケット制	events-slots.md
Wix Stores	ストア、商品、在庫、カタログ	stores-slots.md
Wix Restaurants	レストラン、予約、オンライン注文、メニュー	restaurants-slots.md

出力に関する制約

トークン上限： 出力の上限は約 10,000 トークンです。この上限を超えないように回答を計画してください。

• タスクに直接必要なファイルのみを出力してください。
• 明示的に依頼されていない限り、README.md やドキュメントファイルを追加しないでください。