docs: update document of plugin example (#361)

修改插件开发案例文档,来匹配最新的 [plugin-starter](https://github.com/halo-dev/plugin-starter)。

```release-note
None
```
wan92hen-patch-1
apanonar 6 months ago committed by GitHub
parent 9420d37857
commit f995b1a5ae
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -218,43 +218,23 @@ public class TodoListPlugin extends BasePlugin {
### 实现 ### 实现
使用模板仓库创建的项目中与 `src` 目录同级有一个 `console` 目录,它即为用户界面的源码目录。 使用模板仓库创建的项目中与 `src` 目录同级有一个 `ui` 目录,它即为用户界面的源码目录。
在实现用户界面前我们需要先修改 `console/vite.config.ts` 中的 `pluginName``plugin.yaml` 中的 `metadata.name`,它用来标识此用户界面所属于插件名 pluginName 标识的插件,以便 Halo 加载 console 目录打包产生的文件。 打开 `ui/src/index.ts` 文件,修改如下:
修改完成后执行
```groovy
./gradlew build
```
修改前端项目不需要重启 Halo只需要 build 然后刷新页面,此时能看到多出来一个菜单项:
![hello-world-in-plugin-list](/img/plugin-hello-world.png)
而我们需要实现的目标中也需要一个菜单项,所以直接修改它即可。
打开 `console/src/index.ts` 文件,修改如下:
```diff ```diff
export default definePlugin({ export default definePlugin({
- name: "PluginStarter", components: {},
+ name: "plugin-hello-world",
components: [],
routes: [ routes: [
{ {
parentName: "Root", parentName: "Root",
route: { route: {
- path: "/example", - path: "/example",
+ path: "/todos", // TodoList 的路由 path + path: "/todos", // TodoList 的路由 path
children: [
{
path: "",
- name: "Example", - name: "Example",
+ name: "TodoList",// 菜单标识名 + name: "TodoList",// 菜单标识名
component: DefaultView, component: HomeView,
meta: { meta: {
- permissions: ["plugin:apples:view"],
- title: "示例页面", - title: "示例页面",
+ title: "Todo List",//菜单页的浏览器 tab 标题 + title: "Todo List",//菜单页的浏览器 tab 标题
searchable: true, searchable: true,
@ -263,29 +243,25 @@ export default definePlugin({
+ name: "Todo List",// TODO 菜单显示名称 + name: "Todo List",// TODO 菜单显示名称
- group: "示例分组", - group: "示例分组",
= group: "工具",// 所在组名 = group: "工具",// 所在组名
icon: markRaw(IconGrid), icon: markRaw(IconPlug),
priority: 0, priority: 0,
}, },
}, },
}, },
],
},
}, },
], ],
extensionPoints: {}, extensionPoints: {},
activated() {},
deactivated() {},
}); });
``` ```
完成此步骤后 Console 左侧菜单多了一个名 `工具` 的组,其下有 `Todo List`,浏览器标签页名称也是 `Todo List` 完成此步骤后 Console 左侧菜单多了一个名 `工具` 的组,其下有 `Todo List`,浏览器标签页名称也是 `Todo List`
接来下我们需要在右侧内容区域实现 [目标](#目标) 中图示的 Todo 样式,为了快速上手,我们使用 [todomvc](https://todomvc.com/examples/vue/) 提供的 Vue 标准实现。 接来下我们需要在右侧内容区域实现 [目标](#目标) 中图示的 Todo 样式,为了快速上手,我们使用 [todomvc](https://todomvc.com/examples/vue/) 提供的 Vue 标准实现。
编辑 `console/src/views/DefaultView.vue` 文件,清空它的内容,并拷贝 [examples/#todomvc](https://vuejs.org/examples/#todomvc) 的所有代码粘贴到此文件中,并执行以下步骤: 编辑 `ui/src/views/HomeView.vue` 文件,清空它的内容,并拷贝 [examples/#todomvc](https://vuejs.org/examples/#todomvc) 的所有代码粘贴到此文件中,并执行以下步骤:
1. `cd console` 切换到 `console` 目录。 1. `cd ui` 切换到 `ui` 目录。
2. ` pnpm install todomvc-app-css ` 2. ` pnpm install todomvc-app-css `
3. 修改 `console/src/views/DefaultView.vue` 最底部的 `style` 标签。 3. 修改 `ui/src/views/HomeView.vue` 最底部的 `style` 标签。
```diff ```diff
- <style> - <style>
@ -303,7 +279,7 @@ export default definePlugin({
本章节我们将通过使用 `Axios` 来完成与插件后端 APIs 进行数据交互,文档参考 [axios-http](https://axios-http.com/docs)。 本章节我们将通过使用 `Axios` 来完成与插件后端 APIs 进行数据交互,文档参考 [axios-http](https://axios-http.com/docs)。
首先需要安装 `Axios`console 目录下执行命令: 首先需要安装 `Axios`ui 目录下执行命令:
```shell ```shell
pnpm install axios pnpm install axios
@ -311,7 +287,7 @@ pnpm install axios
为了符合最佳实践,将用 TypeScript 改造之前的 todomvc 示例: 为了符合最佳实践,将用 TypeScript 改造之前的 todomvc 示例:
创建 types 文件 `console/src/types/index.ts` 创建 types 文件 `ui/src/types/index.ts`
```typescript ```typescript
export interface Metadata { export interface Metadata {
@ -358,7 +334,7 @@ export interface TodoList {
} }
``` ```
编辑 `console/src/views/DefaultView.vue` 文件,将所有内容替换为如下写法: 编辑 `ui/src/views/HomeView.vue` 文件,将所有内容替换为如下写法:
```typescript ```typescript
<script setup lang="ts"> <script setup lang="ts">
@ -581,12 +557,12 @@ const handleDelete = (todo: Todo) => {
### 用户界面使用静态资源 ### 用户界面使用静态资源
如果你想在用户界面中使用图片,你可以放到 `console/src/assets` 中,例如 `logo.png`,并将其作为 Todo 的 Logo 放到标题旁边。 如果你想在用户界面中使用图片,你可以放到 `ui/src/assets` 中,例如 `logo.svg`,并将其作为 Todo 的 Logo 放到标题旁边。
需要修改 `console/src/views/DefaultView.vue` 示例如下: 需要修改 `ui/src/views/HomeView.vue` 示例如下:
```diff ```diff
+ import Logo from "../assets/logo.png"; + import Logo from "@/assets/logo.svg";
// ... // ...
<template> <template>
<section class="todoapp"> <section class="todoapp">

Loading…
Cancel
Save