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" }],
	},
});

描述符需要一个对应的 adminEntry，以便 EmDash 在构建时知道在哪里找到组件：

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",
		},
	],
}

请用英文声明标签。管理界面在渲染侧边栏和命令面板之前，会通过其共享的 Lingui 实例处理标签，因此加载自己消息目录的插件（使用英文标签作为消息 ID）可以免费获得本地化导航。与管理界面自身消息（Settings、Dashboard 等）匹配的标签即使没有插件目录也会使用管理界面的翻译；没有目录条目的标签按声明时的样子渲染。

import { i18n } from "@lingui/core";

// 将插件的编译目录合并到管理界面的 i18n 实例中。
// 当管理界面的语言环境为德语时，"Reports" 现在渲染为 "Berichte"。
const catalogs: Record<string, Record<string, string>> = {
	de: { Reports: "Berichte", Settings: "Einstellungen" },
};

function mergeCatalog() {
	const messages = catalogs[i18n.locale];
	if (messages && !("Reports" in i18n.messages)) i18n.load(i18n.locale, messages);
}

mergeCatalog();
// 管理界面的语言环境切换器在更改时会*替换*目录，因此需要重新合并。
// 上面的哨兵检查防止递归（load() 会触发 "change"）。
i18n.on("change", mergeCatalog);

页面组件

以下组件通过插件 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>插件设置</h1>

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

			<button onClick={handleSave} disabled={saving}>
				{saving ? "保存中..." : "保存设置"}
			</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 });          // 使用 JSON 正文 POST
	const result = await api.get("history?limit=50");            // 支持查询参数
}

仪表盘小组件

小组件显示在管理仪表盘上，提供一目了然的信息。

小组件定义

在 admin.widgets 下声明每个小组件，包含 ID、标题和大小：

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>
	);
}

小组件大小

小组件根据屏幕宽度自动换行。

导出结构

管理入口点导出两个对象：

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="设置">
			<Input label="API 密钥" type="password" />
			<Toggle label="启用" defaultChecked />
			<Button variant="primary">保存</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" },  // 第一个
		{ path: "/history", label: "History", icon: "history" },     // 第二个
		{ path: "/reports", label: "Reports", icon: "chart" },        // 第三个
	],
}

构建配置

管理组件需要一个单独的构建入口点。以下打包器配置同时构建服务器和管理入口点：

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

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,
};