E EmDash CMS Everything Guides, use cases, plugins, templates
日本語

React管理ページとウィジェット

このページ

ネイティブプラグインは、カスタムReactページとダッシュボードウィジェットで管理パネルを拡張できます。サンドボックス化されたプラグインは、代わりにBlock KitとしてUIを記述します。これは、プラグインのJavaScriptを管理画面に送信すると、サンドボックスの分離が破られるためです。

プラグインが設定フォームのみを必要とする場合、自動生成されたadmin.settingsSchemaフォーム（最初のネイティブプラグインを参照）は、Reactを書かずにほとんどのケースをカバーします。settingsSchemaが提供するよりも豊富なUIが必要な場合は、カスタムコンポーネントを使用してください。

管理エントリーポイント

管理UIを持つプラグインは、adminエントリーポイントからpagesとwidgetsオブジェクトをエクスポートします。

import { SEOSettingsPage } from "./components/SEOSettingsPage";
import { SEODashboardWidget } from "./components/SEODashboardWidget";

export const widgets = {
	"seo-overview": SEODashboardWidget,
};

export const pages = {
	"/settings": SEOSettingsPage,
};

package.jsonでエントリーポイントを設定します。

{
	"exports": {
		".": "./dist/index.js",
		"./admin": "./dist/admin.js"
	}
}

definePlugin()から参照します。

definePlugin({
	id: "seo",
	version: "1.0.0",

	admin: {
		entry: "@my-org/plugin-seo/admin",
		pages: [{ path: "/settings", label: "SEO Settings", icon: "settings" }],
		widgets: [{ id: "seo-overview", title: "SEO Overview", size: "half" }],
	},
});

EmDashがビルド時にコンポーネントを見つけられるように、ディスクリプタには一致するadminEntryが必要です。

adminEntry: "@my-org/plugin-seo/admin",

管理ページ

管理ページは、/_emdash/admin/plugins/<plugin-id>/<path>の下にマウントされるReactコンポーネントです。

ページ定義

パス、ラベル、アイコンを使用して、admin.pagesの下に各ページを宣言します。

admin: {
	pages: [
		{
			path: "/settings",
			label: "Settings",
			icon: "settings",
		},
		{
			path: "/reports",
			label: "Reports",
			icon: "chart",
		},
	],
}

ページコンポーネント

次のコンポーネントは、プラグインAPIフックを通じて設定を読み取り、保存します。

import { useState, useEffect } from "react";
import { usePluginAPI } from "@emdash-cms/admin";

export function SettingsPage() {
	const api = usePluginAPI();
	const [settings, setSettings] = useState<Record<string, unknown>>({});
	const [saving, setSaving] = useState(false);

	useEffect(() => {
		api.get("settings").then(setSettings);
	}, []);

	const handleSave = async () => {
		setSaving(true);
		await api.post("settings/save", settings);
		setSaving(false);
	};

	return (
		<div>
			<h1>Plugin Settings</h1>

			<label>
				Site Title
				<input
					type="text"
					value={(settings.siteTitle as string) || ""}
					onChange={(e) => setSettings({ ...settings, siteTitle: e.target.value })}
				/>
			</label>

			<button onClick={handleSave} disabled={saving}>
				{saving ? "Saving..." : "Save Settings"}
			</button>
		</div>
	);
}

プラグインAPIフック

usePluginAPI()は、プラグインIDプレフィックスと自動的に追加されるX-EmDash-Request: 1 CSRFヘッダーを使用して、プラグインのルートを呼び出します。

import { usePluginAPI } from "@emdash-cms/admin";

function MyComponent() {
	const api = usePluginAPI();

	const data = await api.get("status");                       // GET /_emdash/api/plugins/<id>/status
	await api.post("settings/save", { enabled: true });          // POST with JSON body
	const result = await api.get("history?limit=50");            // query params supported
}

ダッシュボードウィジェット

ウィジェットは管理ダッシュボードに表示され、一目で情報を提供します。

ウィジェット定義

id、タイトル、サイズを使用して、admin.widgetsの下に各ウィジェットを宣言します。

admin: {
	widgets: [
		{
			id: "seo-overview",
			title: "SEO Overview",
			size: "half",   // "full" | "half" | "third"
		},
	],
}

ウィジェットコンポーネント

次のコンポーネントは、マウント時にデータを取得し、コンパクトな概要をレンダリングします。

import { useState, useEffect } from "react";
import { usePluginAPI } from "@emdash-cms/admin";

export function SEOWidget() {
	const api = usePluginAPI();
	const [data, setData] = useState({ score: 0, issues: [] });

	useEffect(() => {
		api.get("analyze").then(setData);
	}, []);

	return (
		<div className="widget-content">
			<div className="score">{data.score}%</div>
			<ul>
				{data.issues.map((issue, i) => (
					<li key={i}>{(issue as { message: string }).message}</li>
				))}
			</ul>
		</div>
	);
}

ウィジェットサイズ

SizeDescription
fullダッシュボードの全幅
halfダッシュボードの半分の幅
thirdダッシュボードの3分の1の幅

ウィジェットは、画面幅に基づいて自動的に折り返されます。

エクスポート構造

管理エントリーポイントは2つのオブジェクトをエクスポートします。

import { SettingsPage } from "./components/SettingsPage";
import { ReportsPage } from "./components/ReportsPage";
import { StatusWidget } from "./components/StatusWidget";
import { OverviewWidget } from "./components/OverviewWidget";

export const pages = {
	"/settings": SettingsPage,
	"/reports": ReportsPage,
};

export const widgets = {
	status: StatusWidget,
	overview: OverviewWidget,
};

管理コンポーネントの使用

EmDashは、一般的なパターン用の事前構築されたコンポーネントを提供します。

import {
	Card,
	Button,
	Input,
	Select,
	Toggle,
	Table,
	Pagination,
	Alert,
	Loading,
} from "@emdash-cms/admin";

function SettingsPage() {
	return (
		<Card title="Settings">
			<Input label="API Key" type="password" />
			<Toggle label="Enabled" defaultChecked />
			<Button variant="primary">Save</Button>
		</Card>
	);
}

自動生成された設定UI

プラグインが設定フォームのみを必要とする場合は、カスタムコンポーネントなしでadmin.settingsSchemaを使用します。

admin: {
	settingsSchema: {
		apiKey: { type: "secret", label: "API Key" },
		enabled: { type: "boolean", label: "Enabled", default: true },
	},
},

EmDashは自動的に設定ページを生成します。基本フォームを超える動作が必要な場合にのみ、カスタムReactページを使用してください。

ナビゲーション

プラグインページは、プラグイン名の下の管理サイドバーに表示されます。順序は、以下に示すようにadmin.pages配列と一致します。

admin: {
	pages: [
		{ path: "/settings", label: "Settings", icon: "settings" },  // first
		{ path: "/history", label: "History", icon: "history" },     // second
		{ path: "/reports", label: "Reports", icon: "chart" },        // third
	],
}

ビルド構成

管理コンポーネントには、別のビルドエントリーポイントが必要です。次のバンドラー構成は、サーバーと管理エントリーポイントの両方をビルドします。

tsdown

export default {
	entry: {
		index: "src/index.ts",
		admin: "src/admin.tsx",
	},
	format: "esm",
	dts: true,
	external: ["react", "react-dom", "emdash", "@emdash-cms/admin"],
};

tsup

export default {
	entry: ["src/index.ts", "src/admin.tsx"],
	format: "esm",
	dts: true,
	external: ["react", "react-dom", "emdash", "@emdash-cms/admin"],
};

重複をバンドルしないように、ReactとEmDash adminを外部依存関係として保持してください。

プラグインの有効化/無効化

管理画面でプラグインが無効になっている場合：

  • サイドバーリンクは非表示になります。
  • ダッシュボードウィジェットはレンダリングされません。
  • 管理ページは404を返します。
  • バックエンドフックは引き続き実行されます（データの安全性のため）。

プラグインは有効状態を確認できます。

const enabled = await ctx.kv.get<boolean>("_emdash:enabled");

完全な例

次のプラグインは、ダッシュボードページ、設定ページ、ウィジェットを定義し、ランタイムと管理エントリーポイントが別のファイルにあります。src/index.tsファイルにはディスクリプタとランタイムが含まれています。

import { definePlugin } from "emdash";
import type { PluginDescriptor } from "emdash";

export function analyticsPlugin(): PluginDescriptor {
	return {
		id: "analytics",
		version: "1.0.0",
		format: "native",
		entrypoint: "@my-org/plugin-analytics",
		adminEntry: "@my-org/plugin-analytics/admin",
		adminPages: [
			{ path: "/dashboard", label: "Dashboard", icon: "chart" },
			{ path: "/settings", label: "Settings", icon: "settings" },
		],
		adminWidgets: [{ id: "events-today", title: "Events Today", size: "third" }],
	};
}

export function createPlugin() {
	return definePlugin({
		id: "analytics",
		version: "1.0.0",

		capabilities: ["network:request"],
		allowedHosts: ["api.analytics.example.com"],

		storage: {
			events: { indexes: ["type", "createdAt"] },
		},

		admin: {
			entry: "@my-org/plugin-analytics/admin",
			settingsSchema: {
				trackingId: { type: "string", label: "Tracking ID" },
				enabled: { type: "boolean", label: "Enabled", default: true },
			},
			pages: [
				{ path: "/dashboard", label: "Dashboard", icon: "chart" },
				{ path: "/settings", label: "Settings", icon: "settings" },
			],
			widgets: [{ id: "events-today", title: "Events Today", size: "third" }],
		},

		routes: {
			stats: {
				handler: async (ctx) => {
					const today = new Date().toISOString().split("T")[0];
					const count = await ctx.storage.events.count({
						createdAt: { gte: today },
					});
					return { today: count };
				},
			},
		},
	});
}

export default createPlugin;

src/admin.tsxファイルは、ページパスとウィジェットIDをReactコンポーネントにマッピングします。

import { EventsWidget } from "./components/EventsWidget";
import { DashboardPage } from "./components/DashboardPage";
import { SettingsPage } from "./components/SettingsPage";

export const widgets = {
	"events-today": EventsWidget,
};

export const pages = {
	"/dashboard": DashboardPage,
	"/settings": SettingsPage,
};