Skip to content

Enhance cursor method documentation with additional info and clarify return types #533

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ruibaby merged 2 commits into from
Dec 20, 2025
Merged

Enhance cursor method documentation with additional info and clarify return types #533

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f561c6f
Enhance cursor method documentation with additional info and clarify …
JohnNiang Dec 17, 2025
8c7e0c3
Update API changelog to include changes to cursor(postName) return st…
JohnNiang Dec 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/developer-guide/theme/api-changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,7 @@ description: 记录每一个版本的主题 API 变更记录，方便开发者
### 表单定义 > 新增 `array` 组件

在 2.22.0 中，我们为 FormKit 表单新增了 `array` 组件，用于定义一组数据，并计划使用 `array` 组件替换原有的 `repeater` 组件。详细文档可查阅：[表单定义#array](../../developer-guide/form-schema.md#array)

### 文章 Finder API > 修改 `cursor(postName)` 返回结构

我们修改了文章 Finder API 中 `cursor(postName)` 方法的返回体结构，移除了 `current` 字段，并修改了 `previous` 和 `next` 字段类型为 `ListedPostVo`，并明确了上一篇文章是指发布时间较当前文章更早的文章，下一篇文章是指发布时间较当前文章更新的文章。详细文档可查阅：[文章 Finder API#cursor](../../developer-guide/theme/finder-apis/post.md#cursor)。
9 changes: 6 additions & 3 deletions docs/developer-guide/theme/finder-apis/post.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,10 @@ postFinder.cursor(postName);

根据文章的 `metadata.name` 获取相邻的文章（上一篇 / 下一篇）。

:::info 提示
上一篇文章是指发布时间较当前文章更早的文章，下一篇文章是指发布时间较当前文章更新的文章。
:::

### 参数

1. `postName:string` - 文章的唯一标识 `metadata.name`。
Expand Down Expand Up @@ -448,9 +452,8 @@ postFinder.archives(page, size, year, month);

```json title="NavigationPostVo"
{
"previous": "#PostVo", // 上一篇文章
"current": "#PostVo", // 当前文章
"next": "#PostVo" // 下一篇文章
"previous": "#ListedPostVo", // 上一篇文章，发布时间较当前文章更早的文章
"next": "#ListedPostVo" // 下一篇文章，发布时间较当前文章更新的文章
}
```

Expand Down