管理后台 UI

插件可通过自定义页面和仪表盘小组件扩展管理后台。这些是与核心管理功能一同渲染的 React 组件。

管理入口

含管理 UI 的插件从 admin 入口导出组件：

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

管理页面

管理页面是通过 hooks 接收插件上下文的 React 组件。

页面定义

在 admin.pages 中定义页面：

admin: {
	pages: [
		{
			path: "/settings", // URL 路径（相对于插件基路径）
			label: "Settings", // 侧栏标签
			icon: "settings", // 图标名称（可选）
		},
		{
			path: "/reports",
			label: "Reports",
			icon: "chart",
		},
	];
}

页面挂载在 /_emdash/admin/plugins/<plugin-id>/<path>。

页面组件

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 || ""}
          onChange={(e) => setSettings({ ...settings, siteTitle: e.target.value })}
        />
      </label>

      <label>
        <input
          type="checkbox"
          checked={settings.enabled ?? true}
          onChange={(e) => setSettings({ ...settings, enabled: e.target.checked })}
        />
        Enabled
      </label>

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

插件 API Hook

使用 usePluginAPI() 调用插件路由：

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

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

	// 向插件路由发起 GET 请求
	const data = await api.get("status");

	// 带请求体的 POST 请求
	await api.post("settings/save", { enabled: true });

	// 带 URL 参数
	const result = await api.get("history?limit=50");
}

该 hook 会自动为路由 URL 添加插件 ID 前缀。

仪表盘小组件

小组件显示在管理仪表盘上，提供概览信息。

小组件定义

在 admin.widgets 中定义小组件：

admin: {
	widgets: [
		{
			id: "seo-overview", // 唯一小组件 ID
			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.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,
};

// 小组件以 ID 为键
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 会自动生成设置页面。仅在超出基本设置的功能需求时才添加自定义页面。

导航

插件页面显示在管理侧栏的插件名称下。顺序与 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
• 后端 hooks 仍会执行（保障数据安全）

插件可检查自身的启用状态：

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

示例：完整管理 UI

import { definePlugin } from "emdash";

export default definePlugin({
	id: "analytics",
	version: "1.0.0",

	capabilities: ["network:fetch"],
	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 };
			},
		},
	},
});

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