上一教程:Developing Discourse Plugins - Part 4 - Setup git
有时,站点设置作为管理界面可能不足以让你的插件按你期望的方式工作。例如,如果你安装了 discourse-akismet 插件,你可能已经注意到它在 Discourse 的管理插件部分添加了一个导航项:
在本教程中,我们将展示如何为你的插件添加一个管理界面。为了致敬我最喜欢的电脑游戏之一,我将我的插件命名为 purple-tentacle(紫色触手)。说真的,我非常喜欢那款游戏!
设置管理员路由
让我们像在本教程的前几部分中那样,首先添加一个 plugin.rb 文件。
plugin.rb
# name: purple-tentacle
# about: 一个演示如何添加插件路由的示例插件
# 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 上提出更改。






