Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/halo-sigs/plugin-photos

Halo 2.0 的相册管理插件
https://github.com/halo-sigs/plugin-photos

halo halo-plugin

Last synced: 25 days ago
JSON representation

Halo 2.0 的相册管理插件

Host: GitHub
URL: https://github.com/halo-sigs/plugin-photos
Owner: halo-sigs
License: gpl-3.0
Created: 2022-11-21T14:43:13.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-05-13T03:16:30.000Z (about 2 months ago)
Last Synced: 2024-05-13T04:27:54.548Z (about 2 months ago)
Topics: halo, halo-plugin
Language: Java
Homepage: https://halo.run/store/apps/app-BmQJW
Size: 4.13 MB
Stars: 12
Watchers: 1
Forks: 12
Open Issues: 7
Metadata Files:
- Readme: README.md
- License: LICENSE

Lists

awesome-halo - plugin-photos - Halo 2.0 的图库管理插件 (Halo 2.0 / 插件)

README

# plugin-photos

Halo 2.0 的相册管理插件, 支持在 Console 进行管理以及为主题端提供 `/photos` 页面路由。

## 使用方式

1. 下载，目前提供以下两个下载方式：
- GitHub Releases：访问 [Releases](https://github.com/halo-sigs/plugin-photos/releases) 下载 Assets 中的 JAR 文件。
- Halo 应用市场：
2. 安装，插件安装和更新方式可参考：
3. 安装完成之后，访问 Console 左侧的**图库**菜单项，即可进行管理。
4. 前台访问地址为 `/photos`，需要注意的是，此插件需要主题提供模板（photos.html）才能访问 `/photos`。

## 开发环境

```bash
git clone [email protected]:halo-sigs/plugin-photos.git

# 或者当你 fork 之后

git clone [email protected]:{your_github_id}/plugin-photos.git
```

```bash
cd path/to/plugin-photos
```

```bash
# macOS / Linux
./gradlew pnpmInstall

# Windows
./gradlew.bat pnpmInstall
```

```bash
# macOS / Linux
./gradlew build

# Windows
./gradlew.bat build
```

修改 Halo 配置文件：

```yaml
halo:
plugin:
runtime-mode: development
classes-directories:
- "build/classes"
- "build/resources"
lib-directories:
- "libs"
fixedPluginPath:
- "/path/to/plugin-photos"
```

## 主题适配

目前此插件为主题端提供了 `/photos` 路由，模板为 `photos.html`，也提供了 [Finder API](https://docs.halo.run/developer-guide/theme/finder-apis)，可以将图库列表渲染到任何地方。

### 模板变量

#### 路由信息

- 模板路径：/templates/photos.html
- 访问路径：/photos | /photos/page/{page}

#### 路由可选参数

group: 图片分组名称, 对应 [#PhotoGroupVo](#photogroupvo).metadata.name

示例：/photos?group=photo-group-UEcvi | /photos/page/1?group=photo-group-UEcvi

#### 变量

groups

##### 变量类型

List<[#PhotoGroupVo](#photogroupvo)>

##### 示例

```html

```

#### 变量

photos

##### 变量类型

[#UrlContextListResult\](#urlcontextlistresult)

##### 示例

```html

```

### Finder API

#### groupBy()

##### 描述

获取全部分组内容。

##### 参数

无

##### 返回值

List<[#PhotoGroupVo](#photogroupvo)>

##### 示例

```html

```

#### listAll()

##### 描述

获取全部图库内容。

##### 参数

无

##### 返回值

List<[#PhotoVo](#photovo)>

##### 示例

```html

```

#### listBy(group)

##### 描述

根据分组获取图片列表。

##### 参数

1. `group: string` - 图片分组名称, 对应 PhotoGroupVo.metadata.name

##### 返回值

List<[#PhotoVo](#photovo)>

##### 示例

```html

```

#### list(page, size)

##### 描述

根据分页参数获取图片列表。

##### 参数

1. `page: int` - 分页页码，从 1 开始
2. `size: int` - 分页条数

##### 返回值

[ListResult\](#listresult-photovo)

##### 示例

```html

```

#### list(page, size, group)

##### 描述

根据分页参数及图片所在组获取图片列表。

##### 参数

1. `page: int` - 分页页码，从 1 开始
2. `size: int` - 分页条数
3. `group: string` - 图片分组名称, 对应 PhotoGroupVo.metadata.name

##### 返回值

[ListResult\](#listresult-photovo)

##### 示例

```html

```

### 类型定义

#### PhotoVo

```json
{
"metadata": {
"name": "string", // 唯一标识
"labels": {
"additionalProp1": "string"
},
"annotations": {
"additionalProp1": "string"
},
"creationTimestamp": "2022-11-20T13:06:38.512Z", // 创建时间
},
"spec": {
"displayName": "string", // 图片名称
"description": "string", // 图片描述
"url": "string", // 图片链接
"cover": "string", // 封面链接
"priority": 0, // 优先级
"groupName": "string", // 分组名称，对应分组 metadata.name
},
}
```

#### PhotoGroupVo

```json
{
"metadata": {
"name": "string", // 唯一标识
"labels": {
"additionalProp1": "string"
},
"annotations": {
"additionalProp1": "string"
},
"creationTimestamp": "2022-11-20T13:06:38.512Z", // 创建时间
},
"spec": {
"displayName": "string", // 分组名称
"priority": 0, // 分组优先级
},
"status": {
"photoCount": 0, // 分组下图片数量
},
"photos": "List<#PhotoVo>", // 分组下所有图片列表
}
```

#### ListResult

```json
{
"page": 0, // 当前页码
"size": 0, // 每页条数
"total": 0, // 总条数
"items": "List<#PhotoVo>", // 图片列表数据
"first": true, // 是否为第一页
"last": true, // 是否为最后一页
"hasNext": true, // 是否有下一页
"hasPrevious": true, // 是否有上一页
"totalPages": 0 // 总页数
}
```

#### UrlContextListResult

### Annotations 元数据适配

根据 Halo 的[元数据表单定义文档](https://docs.halo.run/developer-guide/annotations-form/)和[模型元数据文档](https://docs.halo.run/developer-guide/theme/annotations)，Halo 支持为部分模型的表单添加元数据表单，此插件同样适配了此功能，如果你作为主题开发者，需要为链接或者链接分组添加额外的字段，可以参考上述文档并结合下面的 TargetRef 列表进行适配。

| 对应模型 | group | kind |
| ---------- | ---------------- | ---------- |
| 图库 | core.halo.run | Photo |
| 图库分组 | core.halo.run | PhotoGroup |