diff --git a/docs/developer-guide/plugin/api-reference/extension-client.md b/docs/developer-guide/plugin/api-reference/extension-client.md new file mode 100644 index 0000000..d7f88a2 --- /dev/null +++ b/docs/developer-guide/plugin/api-reference/extension-client.md @@ -0,0 +1,104 @@ +--- +title: 与自定义模型交互 +description: 了解如果通过代码的方式操作数据 +--- + +Halo 提供了两个类用于与自定义模型数据交互 `ExtensionClient` 和 `ReactiveExtensionClient`。 + +它们的本质就是操作数据库,区别在于 `ExtensionClient` 是阻塞式 API,而 `ReactiveExtensionClient` 是响应式 API,接口返回值只有两种 Mono 或 Flux,它们由 [reactor](https://projectreactor.io/) 提供。 + +```java +public interface ReactiveExtensionClient { + + /** + * Lists Extensions by Extension type, filter and sorter. + * + * @param type is the class type of Extension. + * @param predicate filters the reEnqueue. + * @param comparator sorts the reEnqueue. + * @param is Extension type. + * @return all filtered and sorted Extensions. + */ + Flux list(Class type, Predicate predicate, + Comparator comparator); + + /** + * Lists Extensions by Extension type, filter, sorter and page info. + * + * @param type is the class type of Extension. + * @param predicate filters the reEnqueue. + * @param comparator sorts the reEnqueue. + * @param page is page number which starts from 0. + * @param size is page size. + * @param is Extension type. + * @return a list of Extensions. + */ + Mono> list(Class type, Predicate predicate, + Comparator comparator, int page, int size); + + /** + * Fetches Extension by its type and name. + * + * @param type is Extension type. + * @param name is Extension name. + * @param is Extension type. + * @return an optional Extension. + */ + Mono fetch(Class type, String name); + + Mono fetch(GroupVersionKind gvk, String name); + + Mono get(Class type, String name); + + /** + * Creates an Extension. + * + * @param extension is fresh Extension to be created. Please make sure the Extension name does + * not exist. + * @param is Extension type. + */ + Mono create(E extension); + + /** + * Updates an Extension. + * + * @param extension is an Extension to be updated. Please make sure the resource version is + * latest. + * @param is Extension type. + */ + Mono update(E extension); + + /** + * Deletes an Extension. + * + * @param extension is an Extension to be deleted. Please make sure the resource version is + * latest. + * @param is Extension type. + */ + Mono delete(E extension); +} +``` + +### 示例 + +如果你想在插件中根据 name 参数查询获取到 Person 自定义模型的数据,则可以这样写: + +```java +private final ReactiveExtensionClient client; + +Mono getPerson(String name) { + return client.fetch(Person.class, name); +} +``` + +或者使用阻塞式 API: + +```java +private final ExtensionClient client; + +Optional getPerson(String name) { + return client.fetch(Person.class, name); +} +``` + +我们建议你更多的使用响应式的 `ReactiveExtensionClient` 去替代 `ExtensionClient`。 diff --git a/docs/developer-guide/plugin/api-reference/extension.md b/docs/developer-guide/plugin/api-reference/extension.md new file mode 100644 index 0000000..8f06d0d --- /dev/null +++ b/docs/developer-guide/plugin/api-reference/extension.md @@ -0,0 +1,127 @@ +--- +title: 自定义模型 +description: 了解什么是自定义模型及如何创建 +--- + +Halo 自定义模型主要参考自 [Kubernetes CRD](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/) 。自定义模型遵循 [OpenAPI v3](https://spec.openapis.org/oas/v3.1.0)。设计目的在于为插件提供自定义数据支持。比如某插件需要存储自定义数据,同时也想读取和操作自定义数据。 + +一个典型的自定义模型 `Java` 代码示例如下: + +```java +import lombok.Data; +import lombok.EqualsAndHashCode; +import lombok.ToString; +import run.halo.app.extension.AbstractExtension; +import run.halo.app.extension.GVK; +import run.halo.app.extension.GroupKind; + +@Data +@EqualsAndHashCode(callSuper = true) +@ToString(callSuper = true) +@GVK(group = "my-plugin.halo.run", + version = "v1alpha1", + kind = "Person", + plural = "persons", + singular = "person") +public class Person extends AbstractExtension { + + @Schema(description = "The description on name field", maxLength = 100) + private String name; + + @Schema(description = "The description on age field", maximum = "150", minimum = "0") + private Integer age; + + @Schema(description = "The description on gender field") + private Gender gender; + + private Person otherPerson; + + public enum Gender { + MALE, FEMALE, + } +} +``` + +要创建一个自定义模型需要三步: + +1. 创建一个类继承 `AbstractExtension`。 +2. 使用 `GVK` 注解。 +3. 在插件 `start()` 生命周期方法中注册自定义模型: + +```java +@Autowired +private SchemeManager schemeManager; + +@Override +public void start() { + schemeManager.register(Person.class); +} +``` + +有了自定义模型后可以通过在插件项目的 `src/main/resources/extensions` 目录下声明 `yaml` 文件来创建一个实例,此目录下的所有自定义模型 `yaml` 都会在插件启动时被创建: + +```yaml +groupVersion: my-plugin.halo.run/v1alpha1 +kind: Person +metadata: + name: fake-person +name: halo +age: 18 +gender: male +``` + +:::tip 释义 + +- @GVK:此注解标识该类为一个自定义模型,同时必须继承 `AbstractExtension`。 + - kind:表示自定义模型所表示的 REST 资源。 + - group:表示一组公开的资源,通常采用域名形式,Halo 项目保留使用空组和任何以“*.halo.run”结尾的组名供其单独使用。 + 选择群组名称时,我们建议选择你的群组或组织拥有的子域,例如“widget.mycompany.com”。 + - version:API 的版本,它与 group 组合使用为 apiVersion=“GROUP/VERSION”,例如“api.halo.run/v1alpha1”。 + - singular: 资源的单数名称,这允许客户端不透明地处理复数和单数,必须全部小写。通常为小写的“kind”。 + - plural: 资源的复数名称,自定义资源在 `/apis///.../` 下提供,必须为全部小写。 +- @Schema:属性校验注解,会在创建/修改资源前对资源校验,参考 [schema-validator](https://www.openapi4j.org/schema-validator.html)。 +::: + +### 自定义模型 API + +定义好自定义模型并注册后,会根据 `GVK` 注解自动生成一组 `CRUD` API,规则为: +`/apis////{extensionname}/` + +对于上述 Person 自定义模型将有以下 APIs: + +```text +GET /apis/my-plugin.halo.run/v1alpha1/persons +PUT /apis/my-plugin.halo.run/v1alpha1/persons/{name} +POST /apis/my-plugin.halo.run/v1alpha1/persons +DELETE /apis/my-plugin.halo.run/v1alpha1/persons/{name} +``` + +### 自定义 API + +在一些场景下,只有自动生成的 `CRUD` API 往往是不够用的,此时可以通过自定义一些 API 来满足功能。 + +你可以使用 `SpringBoot` 的控制器写法来暴露 API,不同的是需要添加 `@ApiVersion` 注解,没有此注解的 `Controller` 将被忽略: + +```java +@ApiVersion("v1alpha1") +@RequestMapping("/apples") +@RestController +public class AppleController { + + @PostMapping("/starting") + public void starting() { + } +} +``` + +当插件被启动时,Halo 将会为此 AppleController 生成统一路径的 API。API 前缀组成规则如下: + +```text +/apis/plugin.api.halo.run/{version}/plugins/{plugin-name}/** +``` + +示例: + +```text +/apis/plugin.api.halo.run/v1alpha1/plugins/my-plugin/apples/starting +``` diff --git a/docs/developer-guide/plugin/api-reference/reverseproxy.md b/docs/developer-guide/plugin/api-reference/reverseproxy.md new file mode 100644 index 0000000..ea26180 --- /dev/null +++ b/docs/developer-guide/plugin/api-reference/reverseproxy.md @@ -0,0 +1,36 @@ +--- +title: 静态资源代理 +description: 了解如果使用静态资源代理来访问插件中的静态资源 +--- + +插件中的静态资源如图片等如果想被外部访问到,需要放到 `src/main/resources` 目录下,并通过创建 ReverseProxy 自定义模型来进行静态资源代理访问。 + +例如 `src/main/resources` 下的 `static` 目录下有一张 `halo.jpg`: + +1. 首先需要在 `src/main/resources/extensions` 下创建一个 `yaml`,文件名可以任意。 +2. 示例配置如下。 + +```yaml +apiVersion: plugin.halo.run/v1alpha1 +kind: ReverseProxy +metadata: + # name 为此资源的唯一标识名称,不允许重复,为了避免与其他插件冲突,推荐带上插件名称前缀 + name: my-plugin-fake-reverse-proxy +rules: + - path: /res/** + file: + directory: static + # 如果想代理 static 下所有静态资源则省略 filename 配置 + filename: halo.jpg +``` + +插件启动后会根据 `/plugins/{plugin-name}/assets/**` 规则生成 API。 +因此该 `ReverseProxy` 的访问路径为: `/plugins/my-plugin/assets/res/halo.jpg`。 + +- `rules` 下可以添加多组规则。 +- `path` 为路径前缀。 +- `file` 表示访问文件系统,目前暂时仅支持这一种。 +- `directory` 表示要代理的目标文件目录,它相对于 `src/main/resources/` 目录。 +- `filename` 表示要代理的目标文件名。 + +`directory` 和 `filename` 都是可选的,但必须至少有一个被配置。 diff --git a/docs/developer-guide/plugin/api-reference/role-template.md b/docs/developer-guide/plugin/api-reference/role-template.md new file mode 100644 index 0000000..a92f2c2 --- /dev/null +++ b/docs/developer-guide/plugin/api-reference/role-template.md @@ -0,0 +1,103 @@ +--- +title: API 权限控制 +description: 了解如果对插件中的 API 定义角色模板以接入权限控制 +--- + +插件中的 APIs 无论是自定义模型自动生成的 APIs 或者是通过 Controller 自定义的 APIs 都只有超级管理员能够访问,如果想将这些 APIs 授权给其他用户访问则需要定义一些 RoleTemplate 的资源以便可以在用户界面上将其分配给其他角色使用。 + +RoleTemplate 的 yaml 资源也需要放到 `src/main/resources/extensions` 目录下,文件名称可以任意,它的 kind 为 Role 但需要一个 label `halo.run/role-template: "true"` 来表示它是角色模板。 + +Halo 的权限控制对同一种资源一般只定义两个 RoleTemplate,一个是只读权限,另一个是管理权限,因此如果没有特殊情况需要更细粒度的控制,我们建议你也保持一致: + +```yaml +apiVersion: v1 +kind: Role +metadata: + # 使用 plugin name 作为前缀防止与其他插件冲突 + name: my-plugin-role-view-persons + labels: + halo.run/role-template: "true" + annotations: + rbac.authorization.halo.run/module: "Persons Management" + rbac.authorization.halo.run/display-name: "Person Manage" + rbac.authorization.halo.run/ui-permissions: | + ["plugin:my-plugin:person:view"] +rules: + - apiGroups: ["my-plugin.halo.run"] + resources: ["my-plugin/persons"] + verbs: ["*"] +--- +apiVersion: v1 +kind: Role +metadata: + name: my-plugin-role-manage-persons + labels: + halo.run/role-template: "true" + annotations: + rbac.authorization.halo.run/dependencies: | + [ "role-template-view-person" ] + rbac.authorization.halo.run/module: "Persons Management" + rbac.authorization.halo.run/display-name: "Person Manage" + rbac.authorization.halo.run/ui-permissions: | + ["plugin:my-plugin:person:manage"] +rules: + - apiGroups: [ "my-plugin.halo.run" ] + resources: [ "my-plugin/persons" ] + verbs: [ "get", "list" ] +``` + +上述便是根据 [自定义模型](./extension.md) 章节中定义的 Person 自定义模型配置角色模板的示例。 + +定义了一个用于管理 Person 资源的角色模板 `my-plugin-role-manage-persons`,它具有所有权限,同时定义了一个只允许查询 Person 资源的角色模板 `my-plugin-role-view-persons`。 + +下面让我们回顾一下这些配置: + +`rules` 是个数组,它允许配置多组规则: + +- `apiGroups` 对应 `GVK` 中的 `group` 所声明的值。 +- `resources` 对应 API 中的 resource 部分,`my-plugin` 表示插件名称。 +- `verbs` 表示请求动词,可选值为 "create", "delete", "deletecollection", "get", "list", "patch", "update"。对应的 HTTP 请求方式如下表所示: + +| HTTP verb | request verb | +| --------- | ------------------------------------------------------------ | +| POST | create | +| GET, HEAD | get (for individual resources), list (for collections, including full object content), watch (for watching an individual resource or collection of resources) | +| PUT | update | +| PATCH | patch | +| DELETE | delete (for individual resources), deletecollection (for collections) | + +`metadata.labels` 中必须包含 `halo.run/role-template: "true"` 以表示它此资源要作为角色模板。 + +`metadata.annotations` 中: + +- `rbac.authorization.halo.run/dependencies`:用于声明角色间的依赖关系,例如管理角色必须要依赖查看角色,以避免分配了管理权限却没有查看权限的情况。 +- `rbac.authorization.halo.run/module`:角色模板分组名称。在此示例中,管理 Person 的模板角色将和查看 Person 的模板角色将被在 UI 层面归为一组展示。 +- `rbac.authorization.halo.run/display-name`:模板角色的显示名称,用于展示为用户可读的名称信息。 +- `rbac.authorization.halo.run/ui-permissions`:用于控制 UI 权限,规则为 `plugin:{your-plugin-name}:scope-name`,使用示例为在插件前端部分入口文件 `index.ts` 中用于控制菜单是否显示或者控制页面按钮是否展示: + +```javascript +{ + path: "", + name: "HelloWorld", + component: DefaultView, + meta: { + permissions: ["plugin:my-plugin:person:view"] + } +} +``` + +以上定义角色模板的方式适合资源型请求,即需要符合以下规则 + +- 以 `/api//[///]` 规则组成 APIs。 +- 以 `/apis///[///]` 规则组成的 APIs。 + +注:`[]`包裹的部分表示可选 + +如果你的 API 不符合以上资源型 API 的规则,则被定型为非资源型 API,例如 `/healthz`,需要使用一下配置方式: + +```yaml +rules: + # nonResourceURL 中的 '*' 是一个全局通配符 + - nonResourceURLs: ["/healthz", "/healthz/*"] + verbs: [ "get", "create"] +``` diff --git a/docs/developer-guide/plugin/examples/todolist.md b/docs/developer-guide/plugin/examples/todolist.md new file mode 100644 index 0000000..b8ca2da --- /dev/null +++ b/docs/developer-guide/plugin/examples/todolist.md @@ -0,0 +1,675 @@ +--- +title: Todo List +description: 这个例子展示了如何开发 Todo List 插件 +--- + +本示例用于展示如何从插件模板创建一个插件并写一个 Todo List: + +首先通过模板仓库创建一个插件,例如叫 `halo-plugin-todolist` + +## 配置你的插件 + +1. 修改 `build.gradle` 中的 `group` 为你自己的,如: + + ```groovy + group = 'run.halo.tutorial' + ``` + +2. 修改 `settings.gradle` 中的 `rootProject.name` + + ```groovy + rootProject.name = 'halo-plugin-todolist' + ``` + +3. 修改插件的描述文件 `plugin.yaml`,它位于 `src/main/resources/plugin.yaml`。示例: + + ```yaml + apiVersion: plugin.halo.run/v1alpha1 + kind: Plugin + metadata: + name: todolist + spec: + enabled: true + requires: ">=2.0.0" + author: + name: halo-dev + website: https://halo.run + logo: https://halo.run/logo + homepage: https://github.com/guqing/halo-plugin-hello-world + displayName: "插件 Todo List" + description: "插件开发的 hello world,用于学习如何开发一个简单的 Halo 插件" + license: + - name: "MIT" + ``` + +参考链接: + +- [SemVer expression](https://github.com/zafarkhaja/jsemver#semver-expressions-api-ranges) +- [表单定义](../form-schema.md) + +此时我们已经准备好了可以开发一个 TodoList 插件的一切,下面让我们正式进入 TodoList 插件开发教程。 + +## 运行插件 + +为了看到效果,首先我们需要让插件能最简单的运行起来。 + +1. 在 `src/main/java` 下创建包,如 `run.halo.tutorial`,在创建一个类 `TodoListPlugin`,它继承自 `BasePlugin` 类内容如下: + +```java +package run.halo.tutorial; + +import org.pf4j.PluginWrapper; +import org.springframework.stereotype.Component; +import run.halo.app.plugin.BasePlugin; + +@Component +public class TodoListPlugin extends BasePlugin { + public TodoListPlugin(PluginWrapper wrapper) { + super(wrapper); + } +} +``` + +`src/main/java` 下的文件结构如下: + +```text +. +└── run + └── halo + └── tutorial + └── TodoListPlugin.java +``` + +然后在项目目录执行命令 + +```shell +./gradlew build +``` + +使用 `IntelliJ IDEA` 打开 Halo,参考 [Halo 开发环境运行](../core/run.md) 及 [插件入门](../hello-world.md) 配置插件的运行模式和路径: + +```yaml +halo: + plugin: + runtime-mode: development + fixed-plugin-path: + # 配置为插件绝对路径 + - /Users/guqing/halo-plugin-todolist +``` + +启动 Halo,然后访问 `http://localhost:8090/console` + +在插件列表将能看到插件已经被正确启用 +![plugin-todolist-in-list-view](/img/todolist-in-list.png) + +## 创建一个自定义模型 + +我们希望 TodoList 能够被持久化以避免重启后数据丢失,因此需要创建一个自定义模型来进行数据持久化。 + +首先创建一个 `class` 名为 `Todo` 并写入如下内容: + +```java +package run.halo.tutorial; + +import static io.swagger.v3.oas.annotations.media.Schema.RequiredMode.REQUIRED; + +import io.swagger.v3.oas.annotations.media.Schema; +import lombok.Data; +import lombok.EqualsAndHashCode; +import run.halo.app.extension.AbstractExtension; +import run.halo.app.extension.GVK; + +@Data +@EqualsAndHashCode(callSuper = true) +@GVK(kind = "Todo", group = "todo.plugin.halo.run", + version = "v1alpha1", singular = "todo", plural = "todos") +public class Todo extends AbstractExtension { + + @Schema(requiredMode = REQUIRED) + private TodoSpec spec; + + @Data + public static class TodoSpec { + + @Schema(requiredMode = REQUIRED, minLength = 1) + private String title; + + @Schema(defaultValue = "false") + private Boolean done; + } +} +``` + +然后在 `TodoListPlugin` 的 `start` 生命周期方法中注册此自定义模型到 Halo 中。 + +```diff +// ... ++ import run.halo.app.extension.SchemeManager; + +@Component +public class TodoListPlugin extends BasePlugin { ++ private final SchemeManager schemeManager; + +- public TodoListPlugin(PluginWrapper wrapper) { ++ public TodoListPlugin(PluginWrapper wrapper, SchemeManager schemeManager) { + super(wrapper); ++ this.schemeManager = schemeManager; + } + + @Override + public void start() { ++ // 插件启动时注册自定义模型 ++ schemeManager.register(Todo.class); + System.out.println("Hello world 插件启动了!"); + } + + @Override + public void stop() { ++ // 插件停用时取消注册自定义模型 ++ Scheme todoScheme = schemeManager.get(Todo.class); ++ schemeManager.unregister(todoScheme); + System.out.println("Hello world 被停止!"); + } + // .... +} +``` + +然后 build 项目,重启 Halo,访问 `http://localhost:8090/swagger-ui.html`, +可以找到如下 Todo APIs: + +![hello world plugin swagger api for toto](/img/halo-plugin-hello-world-todo-swagger-api.png) + +由于所有以 `/api` 和 `/apis` 开头的 APIs 都需要认证才能访问,因此先在 Swagger UI 界面顶部点击 `Authorize` 认证,然后尝试访问 +`GET /apis/todo.plugin.halo.run/v1alpha1/todos` 可以看到如下结果: + +```json +{ + "page": 0, + "size": 0, + "total": 0, + "items": [], + "first": true, + "last": true, + "hasNext": false, + "hasPrevious": false, + "totalPages": 1 +} +``` + +至此我们完成了一个自定义模型的创建和使用插件生命周期方法实现了自定义模型的注册和删除,下一步我们将编写用户界面,使用这些 APIs 完成 TodoList 功能。 + +## 编写用户界面 + +### 目标 + +我们希望实现如下的用户界面: + +- 在左侧菜单添加一个名为 `Todo List` 的菜单项,它属于一个`工具`的组。 +- 内容页为一个简单的 Todo List,它实现以下功能: + - 添加 `Todo item` + - 将一个 `Todo item` 标记为完成,也可以取消完成状态 + - 列表有三个 `Tab` 可供切换,用于过滤数据展示 + +![todo user interface](/img/todo-ui.png) + +### 实现 + +使用模板仓库创建的项目中与 `src` 目录同级有一个 `console` 目录,它即为用户界面的源码目录。 + +在实现用户界面前我们需要先修改 `console/vite.config.ts` 中的 `pluginName` 为 `plugin.yaml` 中的 `metadata.name`,它用来标识此用户界面所属于插件名 pluginName 标识的插件,以便 Halo 加载 console 目录打包产生的文件。 + +修改完成后执行 + +```groovy +./gradlew build +``` + +修改前端项目不需要重启 Halo,只需要 build 然后刷新页面,此时能看到多出来一个菜单项: + +![hello-world-in-plugin-list](/img/plugin-hello-world.png) + +而我们需要实现的目标中也需要一个菜单项,所以直接修改它即可。 + +打开 `console/src/index.ts` 文件,修改如下: + +```diff +export default definePlugin({ +- name: "PluginStarter", ++ name: "plugin-hello-world", + components: [], + routes: [ + { + parentName: "Root", + route: { +- path: "/example", ++ path: "/todos", // TodoList 的路由 path + children: [ + { + path: "", +- name: "Example", ++ name: "TodoList",// 菜单标识名 + component: DefaultView, + meta: { +- permissions: ["plugin:apples:view"], +- title: "示例页面", ++ title: "Todo List",//菜单页的浏览器 tab 标题 + searchable: true, + menu: { +- name: "示例页面", ++ name: "Todo List",// TODO 菜单显示名称 +- group: "示例分组", += group: "工具",// 所在组名 + icon: markRaw(IconGrid), + priority: 0, + }, + }, + }, + ], + }, + }, + ], + extensionPoints: {}, + activated() {}, + deactivated() {}, +}); +``` + +完成此步骤后 Console 左侧菜单多了一个名 `工具` 的组,其下有 `Todo List`,浏览器标签页名称也是 `Todo List`。 + +接来下我们需要在右侧内容区域实现 [目标](#目标) 中图示的 Todo 样式,为了快速上手,我们使用 [todomvc](https://todomvc.com/examples/vue/) 提供的 Vue 标准实现。 +编辑 `console/src/views/DefaultView.vue` 文件,清空它的内容,并拷贝 [examples/#todomvc](https://vuejs.org/examples/#todomvc) 的所有代码粘贴到此文件中,并执行以下步骤: + +1. `cd console` 切换到 `console` 目录。 +2. ` pnpm install todomvc-app-css `。 +3. 修改 `console/src/views/DefaultView.vue` 最底部的 `style` 标签。 + +```diff +- +``` + +4. 重新 Build 后刷新页面,便能看到目标图所示效果。 + +通过以上步骤就实现了一个 Todo List 的用户界面功能,但 `Todo` 数据只是被临时存放到了 `LocalStorage` 中,下一步我们将通过自定义模型生成的 APIs 来让用户界面与服务端交互。 + +### 与服务端数据交互 + +本章节我们将通过使用 `Axios` 来完成与插件后端 APIs 进行数据交互,文档参考 [axios-http](https://axios-http.com/docs)。 + +首先需要安装 `Axios`, 在 console 目录下执行命令: + +```shell +pnpm install axios +``` + +为了符合最佳实践,将用 TypeScript 改造之前的 todomvc 示例: + +1. 创建 types 文件 `console/src/types/index.ts` + +```typescript +export interface Metadata { + name: string; + labels?: { + [key: string]: string; + } | null; + annotations?: { + [key: string]: string; + } | null; + version?: number | null; + creationTimestamp?: string | null; + deletionTimestamp?: string | null; +} + +export interface TodoSpec { + title: string; + done?: boolean; +} + +/** + * 与自定义模型 Todo 对应 + */ +export interface Todo { + spec: TodoSpec; + apiVersion: "todo.plugin.halo.run/v1alpha1"; // apiVersion=自定义模型的 group/version + kind: "Todo"; // Todo 自定义模型中 @GVK 注解中的 kind + metadata: Metadata; +} + +/** + * Todo 自定义模型生成 list API 所对应的类型 + */ +export interface TodoList { + page: number; + size: number; + total: number; + items: Array; + first: boolean; + last: boolean; + hasNext: boolean; + hasPrevious: boolean; + totalPages: number; +} +``` + +编辑 `console/src/views/DefaultView.vue` 文件,将所有内容替换为如下写法: + +```typescript + + + + + +``` + +这在原先的基础上替换为了 `TypeScipt` 写法,并去除了数据保存到 `LocalStorage` 的逻辑,这也是我们推荐的方式,可读性更强,且有 `TypeScript` 提供类型提示。 + +至此我们就完成了与插件后端 APIs 实现 Todo List 数据交互的部分。 + +### 使用 Icon + +目前 Todo 的菜单还是默认的网格样式 Icon,在 `console/src/index.ts` 文件中配置有一个 `icon: markRaw(IconGrid)`。以此为例说明该如何使用其他 `Icon`。 + +1. 安装 [unplugin-icons](https://github.com/antfu/unplugin-icons)。 + +```shell +pnpm install -D unplugin-icons +pnpm install -D @iconify/json +pnpm install -D @vue/compiler-sfc +``` + +2. 编辑 `console/vite.config.ts`,在 `defineConfig` 的 `plugins` 中添加配置,修改如下。 + +```diff ++ import Icons from "unplugin-icons/vite"; + +// https://vitejs.dev/config/ +export default defineConfig({ +- plugins: [vue(), vueJsx()], ++ plugins: [vue(), vueJsx(), Icons({ compiler: "vue3" })], +``` + +3. 在 `console/tsconfig.app.json` 中加入 `unplugni-icons` 的 `types` 配置。 + +```diff +{ + // ... + "compilerOptions": { + // ... + "paths": { + "@/*": ["./src/*"] +- } ++ }, ++ "types": ["unplugin-icons/types/vue"] + } +} +``` + +4. 到 [icones](https://icones.js.org/) 搜索你想要使用的图标,并点击它,然后选择 `Unplugin Icons`,会复制到剪贴板。 + +![unplugin icons selector](/img/unplugin-icons-example.png) + +5. 编辑 `console/src/index.ts` 在 `import` 区域粘贴,并 `icon` 属性。 + +```diff +- import { IconGrid } from "@halo-dev/components"; ++ import VscodeIconsFileTypeLightTodo from "~icons/vscode-icons/file-type-light-todo"; + +export default definePlugin({ + routes: [ + { + // ... + route: { + path: "/todos", + children: [ + { + // ... + meta: { + // ... + menu: { + // ... +- icon: markRaw(IconGrid), ++ icon: markRaw(VscodeIconsFileTypeLightTodo), + priority: 0, + }, + }, + }, + ], + }, + }, + ], + // ... +}); +``` + +### 用户界面使用静态资源 + +如果你想在用户界面中使用图片,你可以放到 `console/src/assets` 中,例如 `logo.png`,并将其作为 Todo 的 Logo 放到标题旁边 + +![todo logo example](/img/todo-logo-check-48.png) + +需要修改 `console/src/views/DefaultView.vue` 示例如下: + +```diff ++ import Logo from "../assets/logo.png"; +// ... +