docs: add docs for getBreadcrumbs of category finder (#384)

### What this PR does?
为分类 Finder API 新增的 getBreadcrumbs 方法提供文档

see also https://github.com/halo-dev/halo/pull/6135

```release-note
None
```
wan92hen-patch-1
guqing 5 months ago committed by GitHub
parent bf152a8458
commit c565125540
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -156,6 +156,35 @@ List<[#CategoryTreeVo](#categorytreevo)>
</ul> </ul>
``` ```
## getBreadcrumbs(name)
```js
categoryFinder.getBreadcrumbs('category-foo')
```
### 描述
获取分类树结构的路径节点,可以通过此方法来构建面包屑导航。
### 参数
- `name:string` - 分类的唯一标识 `metadata.name`,必填。
### 返回值
List<[#CategoryVo](#categoryvo)>
### 示例
```html
<div>
<th:block th:each="category,stats : ${categoryFinder.getBreadcrumbs(category.metadata?.name)}">
<a th:href="@{${category.status.permalink}}" th:text="${category.spec.displayName}"></a>
<span th:if="${!stats.last}">/</span>
</th:block>
</div>
```
## 类型定义 ## 类型定义
### CategoryVo ### CategoryVo

@ -156,6 +156,35 @@ List<[#CategoryTreeVo](#categorytreevo)>
</ul> </ul>
``` ```
## getBreadcrumbs(name)
```js
categoryFinder.getBreadcrumbs('category-foo')
```
### 描述
获取分类树结构的路径节点,可以通过此方法来构建面包屑导航。
### 参数
- `name:string` - 分类的唯一标识 `metadata.name`,必填。
### 返回值
List<[#CategoryVo](#categoryvo)>
### 示例
```html
<div>
<th:block th:each="category,stats : ${categoryFinder.getBreadcrumbs(category.metadata?.name)}">
<a th:href="@{${category.status.permalink}}" th:text="${category.spec.displayName}"></a>
<span th:if="${!stats.last}">/</span>
</th:block>
</div>
```
## 类型定义 ## 类型定义
### CategoryVo ### CategoryVo

Loading…
Cancel
Save