上一教程:Developing Discourse Plugins - Part 4 - Setup git
有时,站点设置 不足以提供您插件所需的管理界面。例如,如果您安装了 discourse-akismet 插件,可能会注意到它在您的 Discourse 管理插件部分添加了一个导航项:
在本教程中,我们将向您展示如何为插件添加管理界面。我将把插件命名为 purple-tentacle,以纪念 我最喜欢的电脑游戏之一。说真的,我真的很喜欢那款游戏!
设置管理路由
首先,像教程前面部分那样添加一个 plugin.rb 文件。
plugin.rb
# name: purple-tentacle
# about: A sample plugin showing how to add a plugin route
# version: 0.1
# authors: Robin Ward
# url: https://github.com/discourse/purple-tentacle
add_admin_route 'purple_tentacle.title', 'purple-tentacle'
Discourse::Application.routes.append do
get '/admin/plugins/purple-tentacle' => 'admin/plugins#index', constraints: StaffConstraint.new
end
add_admin_route 这一行告诉 Discourse,该插件需要在 /admin/plugins 页面上添加一个链接。其标题将来自我们的 i18n 翻译文件中的 purple_tentacle.title,并链接到 purple-tentacle 路由。
下面的几行设置了插件的服务端路由映射。Discourse 假设几乎每个前端路由都有一个提供数据的服务端路由。对于本示例插件,我们实际上不需要从后端获取任何数据,但我们需要告诉 Discourse 在用户直接访问 /admin/plugins/purple-tentacle 时提供某些内容。这一行只是告诉它:“嘿,如果用户直接在服务端访问该 URL,请提供默认的插件内容!”
(如果这让您感到困惑,不必担心,我们在未来的教程中处理服务端操作时会再回到这一点。)
接下来,我们将添加一个模板,当用户访问 /admin/plugins/purple-tentacle 路径时将显示该模板。它只是一个按钮,当用户点击时会显示一个紫色触手的动画 GIF:
assets/javascripts/discourse/templates/admin/plugins-purple-tentacle.gjs
import DButton from "discourse/components/d-button";
<template>
{{#if @controller.tentacleVisible}}
<div class="tentacle">
<img src="https://eviltrout.com/images/tentacle.gif" />
</div>
{{/if}}
<div class="buttons">
<DButton
@label="purple_tentacle.show"
@action={{@controller.showTentacle}}
@icon="eye"
@id="show-tentacle"
/>
</div>
</template>
如果您已经掌握了 Handlebars 的基础知识,这个模板应该很容易理解。<DButton /> 是 Discourse 中用于显示带有标签和图标按钮的组件。
为了连接我们的新模板,我们需要创建一个路由映射:
assets/javascripts/discourse/purple-tentacle-route-map.js
export default {
resource: "admin.adminPlugins",
path: "/plugins",
map() {
this.route("purple-tentacle");
},
};
路由映射是我们为 Discourse 添加的功能,以便插件可以向 Ember 应用添加路由。map() 内的语法与 Ember 路由器 非常相似。在本例中,我们的路由映射非常简单,它只是在 /admin/plugins 下声明了一个名为 purple-tentacle 的路由。
最后,让我们添加翻译字符串:
config/locales/client.en.yml
en:
js:
purple_tentacle:
title: "Purple Tentacle"
show: "Show Purple Tentacle"
如果您重启开发服务器,应该可以访问 /admin/plugins 并看到我们的链接!点击它,您将看到显示紫色触手的按钮:
不幸的是,当您点击按钮时,什么也没发生 ![]()
如果您查看开发者控制台,应该会看到一个错误,提示了原因:
Uncaught Error: Nothing handled the action 'showTentacle'
是的,原因是在我们的模板中,我们依赖以下两点:
- 当用户点击按钮时,控制器上会调用
showTentacle。 showTentacle应将属性tentacleVisible设置为true,以便显示图像。
如果您还没有阅读 Ember 控制器指南,现在是时候去读了,因为我们将为 purple-tentacle 模板实现一个控制器来处理这些逻辑。
创建以下文件:
assets/javascripts/discourse/controllers/admin-plugins-purple-tentacle.js
import Controller from "@ember/controller";
import { action } from "@ember/object";
import { tracked } from "@glimmer/tracking";
export default class AdminPluginsPurpleTentacleController extends Controller {
@tracked tentacleVisible = false;
@action
showTentacle() {
this.tentacleVisible = true;
}
}
现在,当我们刷新页面时,点击按钮就会显示我们的动画角色!

我将把添加一个点击后隐藏触手的按钮作为读者的额外练习 ![]()
如果您在使此插件版本正常运行方面遇到困难,我已将其推送到 GitHub。
系列更多内容
第 1 部分:插件基础
第 2 部分:插件出口
第 3 部分:站点设置
第 4 部分:git 设置
第 5 部分:本主题
第 6 部分:验收测试
第 7 部分:发布您的插件
本文档已进行版本控制 - 请在 GitHub 上提出更改建议。





