Let plugins add actions to page dropdowns

Adds control.hooks.pageActions. A plugin returns a function per page
(ControllerPage, HostViewPage, InstanceViewPage, UserViewPage) that is
called during render and returns menu items. Keys are prefixed with the
plugin name. Plugin items go after the built-in ones and before stop and
delete. The user page and instance templates get a More dropdown only
when a plugin adds actions.

Closes #1243

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
bbassieandClaude Opus 5.5 committed 2026-11-21 19:14:41 +00:00
1 parent 8692ea3941
commit 86befd1231
10 files changed
+180 -9

No files matched your search

+63
View File
@@ -140,6 +140,46 @@ export type ExtensionComponent<K extends PluginExtensionSlot> = React.ComponentT
export type ExtensionComponents = { [K in PluginExtensionSlot]: Map<string, ExtensionComponent<K>> };
/**
* Action added by a plugin to the actions dropdown of a page.
*/
export type PluginPageAction = {
/** Unique within the plugin, the web UI prefixes it with the plugin name. */
key: string;
label: React.ReactNode;
icon?: React.ReactNode;
disabled?: boolean;
danger?: boolean;
onClick?: () => void;
};
export type PageActionsSlotProps = {
/** Controller control button on the controller page. */
ControllerPage: Record<never, never>;
/** Host control button on each host page. */
HostViewPage: {
host: lib.HostDetails;
};
/** More dropdown on each instance and template page. */
InstanceViewPage: {
instance: lib.InstanceDetails;
};
/** More dropdown on each user page. */
UserViewPage: {
user: lib.UserDetails;
};
};
export type PageActionsSlot = keyof PageActionsSlotProps;
/**
* Returns the actions to add to a page. It is called during render like a
* React hook, so it may call hooks such as useAccount or useState.
*/
export type PageActionsHook<K extends PageActionsSlot> = (props: PageActionsSlotProps[K]) => PluginPageAction[];
export type PageActions = { [K in PageActionsSlot]: Map<string, PageActionsHook<K>> };
export type WebPluginContext = lib.PluginLoadContext<{
control: Control;
container: any;
@@ -156,6 +196,7 @@ export class WebHooks extends lib.AsyncHookCollection {
this.extensionComponents = this.newHook();
this.inputComponents = this.newHook();
this.loginForms = this.newHook();
this.pageActions = this.newHook();
this.pages = this.newHook();
}
@@ -225,6 +266,28 @@ export class WebHooks extends lib.AsyncHookCollection {
*/
readonly loginForms: lib.AsyncHook<[], PluginLoginForm[]>;
/**
* Additional actions for the actions dropdown on resource pages.
*
* Each plugin may return a partial mapping of page names to
* functions returning the actions for that page. Plugin actions are
* placed after the built in ones and before stop and delete.
*
* @example
* ```ts
* control.hooks.pageActions.attach("my_plugin", () => ({
* UserViewPage: ({ user }) => [{
* key: "warn",
* label: "Warn",
* onClick: () => control.send(new WarnUserRequest(user.name)),
* }],
* }));
* ```
*/
readonly pageActions: lib.AsyncHook<[], Partial<{
[K in PageActionsSlot]: PageActionsHook<K>;
}>>;
/**
* Additional pages accessible on the web ui.
*
+2
View File
@@ -12,6 +12,7 @@ import { InputInstanceTemplate } from "./components/InputInstance";
import { InputTargetVersion, InputPartialVersion, InputFullVersion } from "./components/InputVersion";
import { Control, ControlConnector } from "./util/websocket";
import { loadedPluginSetKey } from "./util/pluginSet";
import { pageActionsFromHooks } from "./util/plugin_actions";
import * as WebPlugin from "./BaseWebPlugin";
import { pages } from "./pages";
@@ -209,6 +210,7 @@ export default async function bootstrap() {
control.inputComponents = await inputComponentsFromHooks(control);
control.extensionComponents = await extensionComponentsFromHooks(control);
control.pageActions = await pageActionsFromHooks(control.hooks);
control.loginForms = await loginFormsFromHooks(control);
control.pages = await pagesFromHooks(control);
@@ -19,6 +19,7 @@ import PageLayout from "./PageLayout";
import notify, { notifyErrorHandler } from "../util/notify";
import webUiPackage from "../../package.json";
import { hasNpmButtonPermission, NpmButton } from "./NpmButton";
import usePluginActions from "../util/usePluginActions";
import VariableDropdownButton, { VariableDropdownButtonProps } from "./VariableDropdownButton";
const { Title } = Typography;
@@ -30,6 +31,7 @@ function ControllerControlButton({ canRestart, restartRequired }: ControllerCont
const control = useContext(ControlContext);
const [modal, modalContext] = Modal.useModal();
const actions: VariableDropdownButtonProps["actions"] = [];
const pluginActions = usePluginActions("ControllerPage", {});
if (account.hasPermission("core.controller.restart") && canRestart) {
actions.push({
@@ -71,6 +73,8 @@ function ControllerControlButton({ canRestart, restartRequired }: ControllerCont
});
}
actions.push(...pluginActions);
if (account.hasPermission("core.controller.stop")) {
actions.push({
key: "stop",
@@ -25,22 +25,25 @@ import {
import { useSystems } from "../model/system";
import useResourceState from "../util/useResourceState";
import { hasNpmButtonPermission, NpmButton } from "./NpmButton";
import usePluginActions from "../util/usePluginActions";
import VariableDropdownButton, { VariableDropdownButtonProps } from "./VariableDropdownButton";
const { Title } = Typography;
type HostControlButtonProps = {
hostId: number,
host: lib.HostDetails,
instances: ReadonlyMap<number, lib.InstanceDetails>,
canRestart?: boolean,
restartRequired?: boolean,
};
function HostControlButton({ hostId, instances, canRestart, restartRequired }: HostControlButtonProps) {
function HostControlButton({ host, instances, canRestart, restartRequired }: HostControlButtonProps) {
const account = useAccount();
const control = useContext(ControlContext);
const [modal, modalContext] = Modal.useModal();
const hostId = host.id;
const actions: VariableDropdownButtonProps["actions"] = [];
const pluginActions = usePluginActions("HostViewPage", { host });
if (account.hasPermission("core.host.restart") && canRestart) {
actions.push({
@@ -93,6 +96,8 @@ function HostControlButton({ hostId, instances, canRestart, restartRequired }: H
});
}
actions.push(...pluginActions);
if (account.hasPermission("core.host.stop")) {
actions.push({
key: "stop",
@@ -174,7 +179,7 @@ export default function HostViewPage() {
let hostButtons = <Space wrap>
<HostControlButton
hostId={hostId}
host={host}
instances={hostInstances}
canRestart={system?.canRestart}
restartRequired={system?.restartRequired}
@@ -36,6 +36,7 @@ import { useDefaultModPack, useModPacks } from "../model/mod_pack";
import InstanceModPack from "./InstanceModPack";
import useLocalStorage from "../util/useLocalStorage";
import useResourceState from "../util/useResourceState";
import usePluginActions from "../util/usePluginActions";
import { MetricRelativeDate } from "./system_metrics";
type MenuItem = Required<MenuProps>["items"][number];
@@ -150,6 +151,7 @@ function InstanceButtons(props: { instance: lib.InstanceDetails }) {
let [host] = useHost(instance.assignedHost);
const [instances] = useInstances();
const canCreate = account.hasPermission("core.instance.create");
const pluginActions = usePluginActions("InstanceViewPage", { instance });
let instanceButtonMenuItems: MenuItem[] = [];
if (account.hasPermission("core.instance.export_data")) {
@@ -166,6 +168,7 @@ function InstanceButtons(props: { instance: lib.InstanceDetails }) {
label: "Extract players from save",
});
}
instanceButtonMenuItems.push(...pluginActions);
if (account.hasPermission("core.instance.delete")) {
if (instanceButtonMenuItems.length) {
instanceButtonMenuItems.push({ type: "divider" });
@@ -230,6 +233,10 @@ function InstanceButtons(props: { instance: lib.InstanceDetails }) {
icon={<DeleteOutlined />}
onClick={confirmDelete}
>Delete</Button>}
{pluginActions.length > 0
&& <Dropdown placement="bottomRight" trigger={["click"]} menu={{ items: pluginActions }}>
<Button>More <DownOutlined /></Button>
</Dropdown>}
</Space>;
}
@@ -256,11 +263,7 @@ function InstanceButtons(props: { instance: lib.InstanceDetails }) {
buttonText="Create template"
buttonType="default"
/>}
{account.hasAnyPermission(
"core.instance.export_data",
"core.instance.extract_players",
"core.instance.delete",
)
{instanceButtonMenuItems.length > 0
&& <Dropdown placement="bottomRight" trigger={["click"]} menu={instanceButtonsMenuProps}>
<Button>More <DownOutlined /></Button>
</Dropdown>}
@@ -1,10 +1,11 @@
import React, { useEffect, useContext, useState } from "react";
import { useNavigate, useParams } from "react-router-dom";
import {
Button, Col, Descriptions, Form, Input, Popconfirm,
Button, Col, Descriptions, Dropdown, Form, Input, Popconfirm,
Row, Table, Tag, Select, Space, Switch,
} from "antd";
import DeleteOutlined from "@ant-design/icons/DeleteOutlined";
import DownOutlined from "@ant-design/icons/DownOutlined";
import * as lib from "@clusterio/lib";
@@ -21,6 +22,7 @@ import ResourceNotes from "./ResourceNotes";
import ResourceState from "./ResourceState";
import useRowNavigation from "../util/useRowNavigation";
import useResourceState from "../util/useResourceState";
import usePluginActions from "../util/usePluginActions";
import Link from "./Link";
import notify, { notifyErrorHandler } from "../util/notify";
import { formatDuration } from "../util/time_format";
@@ -29,6 +31,16 @@ import { formatFirstSeen, formatLastSeen, sortFirstSeen, sortLastSeen, useUser }
const strcmp = new Intl.Collator(undefined, { numeric: true, sensitivity: "base" }).compare;
function UserPluginActions(props: { user: lib.UserDetails }) {
const pluginActions = usePluginActions("UserViewPage", { user: props.user });
if (!pluginActions.length) {
return null;
}
return <Dropdown placement="bottomRight" trigger={["click"]} menu={{ items: pluginActions }}>
<Button>More <DownOutlined /></Button>
</Dropdown>;
}
// The user page has a lot of optional elements, that does not make it
// praticularly complicated.
// eslint-disable-next-line complexity
@@ -167,6 +179,7 @@ export default function UserViewPage() {
<DeleteOutlined />
</Button>
</Popconfirm>}
<UserPluginActions user={user} />
</Space>}
/>
<Form
@@ -0,0 +1,34 @@
import type {
PageActions, PageActionsHook, PageActionsSlot, PageActionsSlotProps, PluginPageAction, WebHooks,
} from "../BaseWebPlugin";
export async function pageActionsFromHooks(hooks: WebHooks) {
const pageActions: Partial<PageActions> = {};
for (const [source, record] of await hooks.pageActions.collectEntries()) {
for (const [slot, useActions] of Object.entries(record) as [PageActionsSlot, PageActionsHook<any>][]) {
if (!pageActions[slot]) {
pageActions[slot] = new Map();
}
pageActions[slot].set(source, useActions);
}
}
return pageActions;
}
/**
* Call each plugin's actions hook for a page and prefix the keys with the
* plugin name. Must be called during render, the set of plugins is fixed
* after bootstrap so the hooks are called in the same order every time.
*/
export function callPageActions<K extends PageActionsSlot>(
hooks: Map<string, PageActionsHook<K>> | undefined,
props: PageActionsSlotProps[K],
) {
const actions: PluginPageAction[] = [];
for (const [source, useActions] of hooks ?? []) {
for (const action of useActions(props)) {
actions.push({ ...action, key: `${source}.${action.key}` });
}
}
return actions;
}
@@ -0,0 +1,14 @@
import { useContext } from "react";
import ControlContext from "../components/ControlContext";
import type { PageActionsSlot, PageActionsSlotProps, PluginPageAction } from "../BaseWebPlugin";
import { callPageActions } from "./plugin_actions";
/** Actions plugins add to the dropdown of a page. */
export default function usePluginActions<K extends PageActionsSlot>(
slot: K,
props: PageActionsSlotProps[K],
): PluginPageAction[] {
const control = useContext(ControlContext);
return callPageActions(control.pageActions[slot], props);
}
+1
View File
@@ -64,6 +64,7 @@ export class Control extends lib.Link {
public loadedPlugins = new Map<string, lib.PluginWebEnvInfo>();
public inputComponents = new Map<string, WebPlugin.InputComponent>();
public extensionComponents: Partial<WebPlugin.ExtensionComponents> = {};
public pageActions: Partial<WebPlugin.PageActions> = {};
public loginForms: WebPlugin.PluginLoginForm[] = [];
public pages: WebPlugin.PluginPage[] = [];