跳到主要内容
版本：2.20

文章标签

getByName(name)​

tagFinder.getByName(name)
提示

通常建议配合 主题设置 和 标签选择器 使用，让用户自行选择所需的标签。

描述​

根据 metadata.name 获取标签。

参数​

  1. name:string - 标签的唯一标识 metadata.name。

返回值​

#TagVo

示例​

<div th:with="tag = ${tagFinder.getByName('tag-foo')}">
  <a th:href="@{${tag.status.permalink}}" th:text="${tag.spec.displayName}"></a>
</div>

getByNames(names)​

tagFinder.getByNames(names)
提示

通常建议配合 主题设置 和 标签选择器 使用，让用户自行选择所需的标签。

描述​

根据一组 metadata.name 获取标签。

参数​

  1. names:List<string> - 标签的唯一标识 metadata.name 的集合。

返回值​

List<#TagVo>

示例​

<div th:with="tags = ${tagFinder.getByNames({'tag-foo', 'tag-bar'})}">
  <a th:each="tag : ${tags}" th:href="@{${tag.status.permalink}}" th:text="${tag.spec.displayName}"></a>
</div>

list(page,size)​

tagFinder.list(page,size)

描述​

根据分页参数获取标签列表。

参数​

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

返回值​

#ListResult<TagVo>

示例​

<ul th:with="tags = ${tagFinder.list(1,10)}">
  <li th:each="tag : ${tags.items}">
    <a th:href="@{${tag.status.permalink}}" th:text="${tag.spec.displayName}"></a>
  </li>
</ul>

listAll()​

tagFinder.listAll()

描述​

获取所有文章标签。

参数​

无

返回值​

List<#TagVo>

示例​

<ul th:with="tags = ${tagFinder.listAll()}">
  <li th:each="tag : ${tags}">
    <a th:href="@{${tag.status.permalink}}" th:text="${tag.spec.displayName}"></a>
  </li>
</ul>

类型定义​

TagVo​

TagVo
{
  "metadata": {
    "name": "string",                                   // 唯一标识
    "labels": {
      "additionalProp1": "string"
    },
    "annotations": {
      "additionalProp1": "string"
    },
    "creationTimestamp": "2022-11-20T13:06:38.512Z",    // 创建时间
  },
  "spec": {
    "displayName": "string",                            // 显示名称
    "slug": "string",                                   // 别名，通常用于生成 status.permalink
    "color": "#F9fEB1",                                 // 背景颜色
    "cover": "string"                                   // 封面图
  },
  "status": {
    "permalink": "string",                              // 固定链接
  },
  "postCount": 0                                        // 文章数量
}

ListResult<TagVo>​

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